org.ow2.petals.jbi.messaging.registry
Interface EndpointRegistryMBean

All Known Subinterfaces:

EndpointRegistry

All Known Implementing Classes:

AbstractEndpointRegistry, BaseEndpointRegistry, DistributedEndpointRegistryImpl

public interface EndpointRegistryMBean

EndpointRegistryMBean interface exposes method to retrieve information about endpoints activated in the JBI environment domain.

Author:

ofabre - eBM Websourcing

Field Summary

static java.lang.String	KEY_COMPONENT_NAME
static java.lang.String	KEY_CONTAINER_NAME
static java.lang.String	KEY_ENDPOINT_NAME
static java.lang.String	KEY_INTERFACE_NAMES
static java.lang.String	KEY_SERVICE_NAME
static java.lang.String	KEY_TYPE
static java.lang.String	TYPE_EXTERNAL Deprecated.
static java.lang.String	TYPE_INTERNAL Deprecated.
static java.lang.String	UNDEFINED

Method Summary

java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getAllEndpoints() Retrieve all activated endpoints (internal, external and connections) information for the current Domain.
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getAllExternalEndpoints() Retrieve all activated external endpoints information for the current Domain.
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getAllInternalEndpoints() Retrieve all activated internal endpoints information for the current Domain.
java.lang.String	getDescription(java.lang.String serviceName, java.lang.String endpointName) Returns an InputStream representation of a ServiceEndpoint description

Field Detail

UNDEFINED

static final java.lang.String UNDEFINED

See Also:

Constant Field Values

KEY_TYPE

static final java.lang.String KEY_TYPE

See Also:

Constant Field Values

KEY_INTERFACE_NAMES

static final java.lang.String KEY_INTERFACE_NAMES

See Also:

Constant Field Values

KEY_SERVICE_NAME

static final java.lang.String KEY_SERVICE_NAME

See Also:

Constant Field Values

KEY_ENDPOINT_NAME

static final java.lang.String KEY_ENDPOINT_NAME

See Also:

Constant Field Values

KEY_CONTAINER_NAME

static final java.lang.String KEY_CONTAINER_NAME

See Also:

Constant Field Values

KEY_COMPONENT_NAME

static final java.lang.String KEY_COMPONENT_NAME

See Also:

Constant Field Values

TYPE_INTERNAL

@Deprecated
static final java.lang.String TYPE_INTERNAL

Deprecated.

TYPE_EXTERNAL

@Deprecated
static final java.lang.String TYPE_EXTERNAL

Deprecated.

Method Detail

getAllInternalEndpoints

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getAllInternalEndpoints()

Retrieve all activated internal endpoints information for the current Domain. An endpoint is mapped to a Map with the following fields :

key	type
componentName	String
containerName	String
endpointName	String
serviceName	String
interfaceNames	String[]

Returns:

a List of all activated internal endpoints information for the current Joram Domain. Must be non null, may be empty

getAllExternalEndpoints

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getAllExternalEndpoints()

Retrieve all activated external endpoints information for the current Domain. An endpoint is mapped to a Map with the following fields :

key	type
componentName	String
containerName	String
endpointName	String
serviceName	String
interfaceNames	String[]

Returns:

a List of all activated external endpoints information for the current Domain. Must be non null, may be empty

getAllEndpoints

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getAllEndpoints()

Retrieve all activated endpoints (internal, external and connections) information for the current Domain. An endpoint is mapped to a Map with the following fields :

key	type
componentName	String
containerName	String
endpointName	String
serviceName	String
interfaceNames	String[]
type	String

The type field follow this pattern : 'internal' if it's an internal endpoint, 'external' if it's an external endpoint or '{serviceNamespace}serviceLocalpart@endpointName' if it's a connection

Returns:

a List of all activated endpoints (internal, external and connections) information for the current Joram Domain. Must be non null, may be empty

getDescription

java.lang.String getDescription(java.lang.String serviceName,
                                java.lang.String endpointName)
                                throws javax.jbi.JBIException

Returns an InputStream representation of a ServiceEndpoint description

Parameters:

serviceName - the service QName of this endpoint

endpointName - the unique name of this endpoint

Returns:

a Dom representation of a ServiceEndpoint description

Throws:

java.lang.Exception - if an error occurs during endpoint description retrieval

javax.jbi.JBIException