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

All Known Subinterfaces:
EndpointRegistry

public interface EndpointRegistryMBean

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

Author:
Olivier Fabre - EBM WebSourcing

Method Summary
 List<Map<String,Object>> getAllEndpoints()
          Retrieve all activated endpoints (internal, external and connections) information for the current Domain.
 List<Map<String,Object>> getAllExternalEndpoints()
          Retrieve all activated external endpoints information for the current Domain.
 List<Map<String,Object>> getAllInternalEndpoints()
          Retrieve all activated internal endpoints information for the current Domain.
 String getDescription(String serviceName, String endpointName)
          Returns an InputStream representation of a ServiceEndpoint description
 void synchronizeRegistry()
          Synchronize the registry for the local node
 

Method Detail

getAllInternalEndpoints

List<Map<String,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

List<Map<String,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

List<Map<String,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

String getDescription(String serviceName,
                      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:
javax.jbi.JBIException - if an error occurs during endpoint description retrieval

synchronizeRegistry

void synchronizeRegistry()
                         throws Exception
Synchronize the registry for the local node

Throws:
Exception


Copyright © 2005-2015 Linagora. All Rights Reserved.