com.sun.jbi.messaging

Class RegisteredEndpoint

java.lang.Object

com.sun.jbi.messaging.RegisteredEndpoint

All Implemented Interfaces:

EndpointStatistics, ServiceEndpoint

Direct Known Subclasses:

DynamicEndpoint, ExternalEndpoint, InternalEndpoint, LinkedEndpoint

public abstract class RegisteredEndpoint
extends Object
implements ServiceEndpoint, EndpointStatistics

Abstract base class representing WSDL endpoint registered with the NMS. Specific endpoint types (dynamic, internal, external, mapped) extend this class to address specific endpoint behavior.

Author:

Sun Microsystems, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DYNAMIC ENDPOINT TYPES
static int	EXTERNAL
static int	INTERNAL
static int	LINKED

Constructor Summary

Constructors

Constructor and Description
RegisteredEndpoint(QName service, String endpoint, String ownerId) Creates a new RegisteredEndpoint.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Deep check for equality.
DocumentFragment	getAsReference(QName operationName) ExternalEndpoint implementation should override this method.
String	getEndpointName() Returns the local name of the registered endpoint.
TabularData	getHistoricalStatistics()
QName[]	getInterfaces()
QName[]	getInterfacesInternal()
String	getName()
HashMap	getOperations()
String	getOwnerId()
QName	getServiceName() Returns the qualified name of the service offered at this endpoint.
CompositeData	getStatistics()
abstract int	getType() Indicates the type of endpoint: INTERNAL, EXTERNAL, or DYNAMIC.
int	hashCode()
boolean	implementsInterface(QName interfaceName) Returns true if this endpoint implements the specified interface.
boolean	isActive() Indicates whether this reference is active.
boolean	isDynamic()
boolean	isExternal()
boolean	isInternal()
boolean	isLinked()
void	parseDescriptor(Document descriptor) Parse the endpoint descriptor for operation and interface details and load them into the endpoint reference.
void	resetInUse()
void	setActive(boolean isActive) Specifies whether the reference is active.
void	setInterfaces(QName[] interfaces)
void	setInUse()
void	setOperations(HashMap map)
String	toExternalName()
String	toString()
String	toStringBrief()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DYNAMIC

public static final int DYNAMIC

ENDPOINT TYPES

See Also:

Constant Field Values

INTERNAL

public static final int INTERNAL

See Also:

Constant Field Values

EXTERNAL

public static final int EXTERNAL

See Also:

Constant Field Values

LINKED

public static final int LINKED

See Also:

Constant Field Values

Constructor Detail

RegisteredEndpoint

public RegisteredEndpoint(QName service,
                  String endpoint,
                  String ownerId)

Creates a new RegisteredEndpoint.

Parameters:

service - service name

endpoint - endpoint name

ownerId - id of component which is registering the service

type - endpoint type

Method Detail

getEndpointName

public String getEndpointName()

Returns the local name of the registered endpoint.

Specified by:

getEndpointName in interface ServiceEndpoint

Returns:

qualified name of service.

getServiceName

public QName getServiceName()

Returns the qualified name of the service offered at this endpoint.

Specified by:

getServiceName in interface ServiceEndpoint

Returns:

qualified name of service.

getOwnerId

public String getOwnerId()

isActive

public boolean isActive()

Indicates whether this reference is active.

Returns:

true if the reference is active, false otherwise.

getType

public abstract int getType()

Indicates the type of endpoint: INTERNAL, EXTERNAL, or DYNAMIC.

setActive

public void setActive(boolean isActive)

Specifies whether the reference is active.

Parameters:

isActive - true for yes, false for no

getOperations

public HashMap getOperations()

setOperations

public void setOperations(HashMap map)

getInterfaces

public QName[] getInterfaces()

Specified by:

getInterfaces in interface ServiceEndpoint

getInterfacesInternal

public QName[] getInterfacesInternal()

setInterfaces

public void setInterfaces(QName[] interfaces)

isInternal

public boolean isInternal()

isExternal

public boolean isExternal()

isLinked

public boolean isLinked()

isDynamic

public boolean isDynamic()

implementsInterface

public boolean implementsInterface(QName interfaceName)

Returns true if this endpoint implements the specified interface.

parseDescriptor

public void parseDescriptor(Document descriptor)
                     throws MessagingException

Parse the endpoint descriptor for operation and interface details and load them into the endpoint reference.

Throws:

MessagingException

getAsReference

public DocumentFragment getAsReference(QName operationName)

ExternalEndpoint implementation should override this method.

Get a reference to this endpoint, using an endpoint reference vocabulary that is known to the provider.

Specified by:

getAsReference in interface ServiceEndpoint

Parameters:

operationName - the name of the operation to be performed by a consumer of the generated endpoint reference. Set to null if this is not applicable.

Returns:

endpoint reference as an XML fragment; null if the provider does not support such references.

setInUse

public void setInUse()

resetInUse

public void resetInUse()

getName

public String getName()

Specified by:

getName in interface EndpointStatistics

getStatistics

public CompositeData getStatistics()

Specified by:

getStatistics in interface EndpointStatistics

getHistoricalStatistics

public TabularData getHistoricalStatistics()

Specified by:

getHistoricalStatistics in interface EndpointStatistics

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Deep check for equality.

Overrides:

equals in class Object

toExternalName

public String toExternalName()

toStringBrief

public String toStringBrief()

toString

public String toString()

Overrides:

toString in class Object