MulticastPulseAgent

java.lang.Object
- org.apache.openejb.server.discovery.MulticastPulseAgent

All Implemented Interfaces:

DiscoveryAgent, SelfManaging, ServerService, Service
```
public class MulticastPulseAgent
extends java.lang.Object
implements DiscoveryAgent, ServerService, SelfManaging
```
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String BADURI

static java.lang.String CLIENT

static java.lang.String EMPTY

static java.lang.String SERVER

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`BADURI`
`static java.lang.String`	`CLIENT`
`static java.lang.String`	`EMPTY`
`static java.lang.String`	`SERVER`

Constructor Summary

Constructors
Constructor and Description

MulticastPulseAgent()
This agent listens for client pulses on a defined multicast channel.

Constructors
Constructor and Description
`MulticastPulseAgent()` This agent listens for client pulses on a defined multicast channel.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DiscoveryListener`	`getDiscoveryListener()`
`java.lang.String`	`getHosts()` Lists current broadcast hosts as a comma separated list.
`java.lang.String`	`getIP()`
`java.lang.String`	`getName()`
`int`	`getPort()`
`java.net.DatagramPacket`	`getResponsePacket()`
`static java.net.MulticastSocket[]`	`getSockets(java.lang.String multicastAddress, int port)` Attempts to return at least one socket per valid network interface.
`void`	`init(java.util.Properties p)`
`static boolean`	`isLocalAddress(java.lang.String host, boolean wildcardIsLocal)` Is the provided host a local host
`static boolean`	`isLoopback(java.lang.String host)` Is the provided host a valid loopback address
`void`	`registerService(java.net.URI uri)` register a service
`boolean`	`removeFromIgnore(java.lang.String host)` Remove a host from the ignore list.
`void`	`reportFailed(java.net.URI serviceUri)` A process actively using a service may see it go down before the DiscoveryAgent notices the service's failure.
`void`	`service(java.io.InputStream in, java.io.OutputStream out)`
`void`	`service(java.net.Socket socket)`
`void`	`setDiscoveryListener(DiscoveryListener listener)` Sets the discovery listener
`void`	`start()`
`void`	`stop()`
`void`	`unregisterService(java.net.URI uri)` register a service

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVER
```
public static final java.lang.String SERVER
```
    See Also:
    
    Constant Field Values
  - CLIENT
```
public static final java.lang.String CLIENT
```
    See Also:
    
    Constant Field Values
  - BADURI
```
public static final java.lang.String BADURI
```
    See Also:
    
    Constant Field Values
  - EMPTY
```
public static final java.lang.String EMPTY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MulticastPulseAgent
```
public MulticastPulseAgent()
```
    This agent listens for client pulses on a defined multicast channel. On receipt of a valid pulse the agent responds with its own pulse for a defined amount of time and rate. A client can deliver a pulse as often as required until it is happy of the server response. Both server and client deliver crafted information payloads. The client pulse contains OpenEJB.MCP.Client:(group or *)[:BadUri:URI] The server will only respond to a request for it's own group or * The optional :BadUri: is used by clients to notify a server that it is sending out unreachable URI's The server response pulse contains OpenEJB.MCP.Server:(Service|Service)|(Comma separated host list)
- Method Detail
  - init
```
public void init(java.util.Properties p)
          throws java.lang.Exception
```
    Specified by:
    
    init in interface Service
    
    Throws:
    
    java.lang.Exception
  - getResponsePacket
```
public java.net.DatagramPacket getResponsePacket()
```
  - setDiscoveryListener
```
public void setDiscoveryListener(DiscoveryListener listener)
```
    Description copied from interface: DiscoveryAgent
    
    Sets the discovery listener
    
    Specified by:
    
    setDiscoveryListener in interface DiscoveryAgent
  - getDiscoveryListener
```
public DiscoveryListener getDiscoveryListener()
```
  - registerService
```
public void registerService(java.net.URI uri)
                     throws java.io.IOException
```
    Description copied from interface: DiscoveryAgent
    
    register a service
    
    Specified by:
    
    registerService in interface DiscoveryAgent
    
    Throws:
    
    java.io.IOException
  - unregisterService
```
public void unregisterService(java.net.URI uri)
                       throws java.io.IOException
```
    Description copied from interface: DiscoveryAgent
    
    register a service
    
    Specified by:
    
    unregisterService in interface DiscoveryAgent
    
    Throws:
    
    java.io.IOException
  - reportFailed
```
public void reportFailed(java.net.URI serviceUri)
                  throws java.io.IOException
```
    Description copied from interface: DiscoveryAgent
    
    A process actively using a service may see it go down before the DiscoveryAgent notices the service's failure. That process can use this method to notify the DiscoveryAgent of the failure so that other listeners of this DiscoveryAgent can also be made aware of the failure.
    
    Specified by:
    
    reportFailed in interface DiscoveryAgent
    
    Throws:
    
    java.io.IOException
  - start
```
public void start()
           throws ServiceException
```
    Specified by:
    
    start in interface ServerService
    
    Throws:
    
    ServiceException
  - stop
```
public void stop()
          throws ServiceException
```
    Specified by:
    
    stop in interface ServerService
    
    Throws:
    
    ServiceException
  - service
```
public void service(java.io.InputStream in,
                    java.io.OutputStream out)
             throws ServiceException,
                    java.io.IOException
```
    Specified by:
    
    service in interface ServerService
    
    Throws:
    
    ServiceException
    
    java.io.IOException
  - service
```
public void service(java.net.Socket socket)
             throws ServiceException,
                    java.io.IOException
```
    Specified by:
    
    service in interface ServerService
    
    Throws:
    
    ServiceException
    
    java.io.IOException
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface ServerService
  - getIP
```
public java.lang.String getIP()
```
    Specified by:
    
    getIP in interface ServerService
  - getPort
```
public int getPort()
```
    Specified by:
    
    getPort in interface ServerService
  - getHosts
```
public java.lang.String getHosts()
```
    Lists current broadcast hosts as a comma separated list. Used principally for testing.
    
    Returns:
    
    String
  - removeFromIgnore
```
public boolean removeFromIgnore(java.lang.String host)
```
    Remove a host from the ignore list. Used principally for testing.
    
    Parameters:
    
    host - String
    
    Returns:
    
    True if removed, else false
  - getSockets
```
public static java.net.MulticastSocket[] getSockets(java.lang.String multicastAddress,
                                                    int port)
                                             throws java.lang.Exception
```
    Attempts to return at least one socket per valid network interface. If no valid interface is found then the array will be empty.
    
    Parameters:
    
    multicastAddress - A valid multicast address
    
    port - A valid multicast port
    
    Returns:
    
    MulticastSocket[], may be empty if no valid interfaces exist
    
    Throws:
    
    java.lang.Exception - On invalid parameters
  - isLoopback
```
public static boolean isLoopback(java.lang.String host)
```
    Is the provided host a valid loopback address
    
    Parameters:
    
    host - Host to test
    
    Returns:
    
    True or false
  - isLocalAddress
```
public static boolean isLocalAddress(java.lang.String host,
                                     boolean wildcardIsLocal)
```
    Is the provided host a local host
    
    Parameters:
    
    host - The host to test
    
    wildcardIsLocal - Should 0.0.0.0 or [::] be deemed as local
    
    Returns:
    
    True is the host is a local host else false

Class MulticastPulseAgent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVER

CLIENT

BADURI

EMPTY

Constructor Detail

MulticastPulseAgent

Method Detail

init

getResponsePacket

setDiscoveryListener

getDiscoveryListener

registerService

unregisterService

reportFailed

start

stop

service

service

getName

getIP

getPort

getHosts

removeFromIgnore

getSockets

isLoopback

isLocalAddress