|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ComponentContext
This interface provides access to data needed by a JBI component about the JBI environment in which it is installed, as well providing the means to allow the component to inform the JBI environment about services provided by this component. This interface provides methods for the following functions:
Method Summary | |
---|---|
ServiceEndpoint |
activateEndpoint(QName serviceName,
String endpointName)
Activates the named endpoint with the NMR. |
void |
deactivateEndpoint(ServiceEndpoint endpoint)
Deactivates the given endpoint with the NMR. |
void |
deregisterExternalEndpoint(ServiceEndpoint externalEndpoint)
Deregisters the given external endpoint with the NMR. |
String |
getComponentName()
Get the unique component name of this component, ass assigned by the identification section of this component's installation descriptor. |
DeliveryChannel |
getDeliveryChannel()
Get a channel for this component to use to communicate with the Normalized Message Router. |
ServiceEndpoint |
getEndpoint(QName service,
String name)
Get the service endpoint for the named activated endpoint, if any. |
Document |
getEndpointDescriptor(ServiceEndpoint endpoint)
Retrieve the service description metadata for the specified endpoint. |
ServiceEndpoint[] |
getEndpoints(QName interfaceName)
Queries the NMR for active endpoints that implement the given interface. |
ServiceEndpoint[] |
getEndpointsForService(QName serviceName)
Queries the NMR for active endpoints belonging to the given service. |
ServiceEndpoint[] |
getExternalEndpoints(QName interfaceName)
Queries the NMR for external endpoints that implement the given interface name. |
ServiceEndpoint[] |
getExternalEndpointsForService(QName serviceName)
Queries the NMR for external endpoints that are part of the given service. |
String |
getInstallRoot()
Get the installation root directory path for this component. |
Logger |
getLogger(String suffix,
String resourceBundleName)
Get a logger instance from JBI. |
MBeanNames |
getMBeanNames()
Get a reference to the MBeanNames creator for use in creating custom MBean names. |
MBeanServer |
getMBeanServer()
Get the JMX MBean server used to register all MBeans in the JBI environment. |
InitialContext |
getNamingContext()
Get the JNDI naming context for this component. |
Object |
getTransactionManager()
Get the TransactionManager for this implementation. |
String |
getWorkspaceRoot()
Get the root directory path for this component's private workspace. |
void |
registerExternalEndpoint(ServiceEndpoint externalEndpoint)
Registers the given external endpoint with the NMR. |
ServiceEndpoint |
resolveEndpointReference(DocumentFragment epr)
Resolve the given endpoint reference into a service endpoint. |
Method Detail |
---|
ServiceEndpoint activateEndpoint(QName serviceName, String endpointName) throws JBIException
Component.getServiceDescription(ServiceEndpoint)
method before returning
from this method call; the component's implementation must be ready to supply
service description metadata before the result of this activation call (a
ServiceEndpoint) is known.
serviceName
- qualified name of the service the endpoint exposes; must
be non-null.endpointName
- the name of the endpoint to be activated; must be non-null
and non-empty.
JBIException
- if the endpoint cannot be activated.void deactivateEndpoint(ServiceEndpoint endpoint) throws JBIException
endpoint
- reference to the endpoint to be deactivated; must be non-null.
JBIException
- if the endpoint cannot be deactivated.void registerExternalEndpoint(ServiceEndpoint externalEndpoint) throws JBIException
externalEndpoint
- the external endpoint to be registered, must be non-null.
JBIException
- if an external endpoint with the same name is already registered,
by this or another component.void deregisterExternalEndpoint(ServiceEndpoint externalEndpoint) throws JBIException
externalEndpoint
- the external endpoint to be deregistered; must be non-null.
JBIException
- if the given external endpoint was not previously registered.ServiceEndpoint resolveEndpointReference(DocumentFragment epr)
epr
- endpoint reference as an XML fragment; must be non-null.
String getComponentName()
DeliveryChannel getDeliveryChannel() throws MessagingException
MessagingException
- if a channel has already been opened, but not yet closed.ServiceEndpoint getEndpoint(QName service, String name)
service
- qualified-name of the endpoint's service; must be non-null.name
- name of the endpoint; must be non-null.
Document getEndpointDescriptor(ServiceEndpoint endpoint) throws JBIException
endpoint
- endpoint reference; must be non-null.
JBIException
- invalid endpoint reference.ServiceEndpoint[] getEndpoints(QName interfaceName)
registerExternalEndpoint(ServiceEndpoint)
).
interfaceName
- qualified name of interface/portType that is implemented
by the endpoint; if null then all activated endpoints in
the JBI environment must be returned.
ServiceEndpoint[] getEndpointsForService(QName serviceName)
registerExternalEndpoint(ServiceEndpoint)
).
serviceName
- qualified name of the service that the endpoints are part
of; must be non-null.
ServiceEndpoint[] getExternalEndpoints(QName interfaceName)
registerExternalEndpoint(ServiceEndpoint)
).
interfaceName
- qualified name of interface implemented by the endpoints;
must be non-null.
ServiceEndpoint[] getExternalEndpointsForService(QName serviceName)
serviceName
- qualified name of service that contains the endpoints;
must be non-null.
String getInstallRoot()
Logger getLogger(String suffix, String resourceBundleName) throws MissingResourceException, JBIException
suffix
- for creating subloggers; use an empty string for the base component
logger; must be non-null.resourceBundleName
- name of ResourceBundle to be used for localizing messages
for the logger. May be null if none of the messages require
localization. The resource, if non-null, must be loadable
using the component's class loader as the initiating loader.
MissingResourceException
- if the ResourceBundleName is non-null and no
corresponding resource can be found.
JBIException
- if the resourceBundleName has changed from a previous invocation
by this component of this method with the same suffix.MBeanNames getMBeanNames()
MBeanServer getMBeanServer()
InitialContext getNamingContext()
Object getTransactionManager()
String getWorkspaceRoot()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |