|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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(javax.xml.namespace.QName serviceName,
java.lang.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. |
java.lang.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(javax.xml.namespace.QName service,
java.lang.String name)
Get the service endpoint for the named activated endpoint, if any. |
org.w3c.dom.Document |
getEndpointDescriptor(ServiceEndpoint endpoint)
Retrieve the service description metadata for the specified endpoint. |
ServiceEndpoint[] |
getEndpoints(javax.xml.namespace.QName interfaceName)
Queries the NMR for active endpoints that implement the given interface. |
ServiceEndpoint[] |
getEndpointsForService(javax.xml.namespace.QName serviceName)
Queries the NMR for active endpoints belonging to the given service. |
ServiceEndpoint[] |
getExternalEndpoints(javax.xml.namespace.QName interfaceName)
Queries the NMR for external endpoints that implement the given interface name. |
ServiceEndpoint[] |
getExternalEndpointsForService(javax.xml.namespace.QName serviceName)
Queries the NMR for external endpoints that are part of the given service. |
java.lang.String |
getInstallRoot()
Get the installation root directory path for this component. |
java.util.logging.Logger |
getLogger(java.lang.String suffix,
java.lang.String resourceBundleName)
Get a logger instance from JBI. |
MBeanNames |
getMBeanNames()
Get a reference to the MBeanNames creator for use in creating custom MBean names. |
javax.management.MBeanServer |
getMBeanServer()
Get the JMX MBean server used to register all MBeans in the JBI environment. |
javax.naming.InitialContext |
getNamingContext()
Get the JNDI naming context for this component. |
java.lang.Object |
getTransactionManager()
Get the TransactionManager for this implementation. |
java.lang.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(org.w3c.dom.DocumentFragment epr)
Resolve the given endpoint reference into a service endpoint. |
Method Detail |
public ServiceEndpoint activateEndpoint(javax.xml.namespace.QName serviceName, java.lang.String endpointName) throws JBIException
Note that the JBI implementation may call this component's 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.public 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.public 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.public 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.public ServiceEndpoint resolveEndpointReference(org.w3c.dom.DocumentFragment epr)
Note that the service endpoint returned refers to a dynamic endpoint; the endpoint will exist only as long as this component retains a strong reference to the object returned by this method. The endpoint may not be included in the list of "activated" endpoints.
epr
- endpoint reference as an XML fragment; must be non-null.
null
if the reference cannot be resolved.public java.lang.String getComponentName()
public DeliveryChannel getDeliveryChannel() throws MessagingException
MessagingException
- if a channel has already been opened,
but not yet closed.public ServiceEndpoint getEndpoint(javax.xml.namespace.QName service, java.lang.String name)
service
- qualified-name of the endpoint's service; must be
non-null.name
- name of the endpoint; must be non-null.
null
if the named endpoint
is not activated.public org.w3c.dom.Document getEndpointDescriptor(ServiceEndpoint endpoint) throws JBIException
Note that the result can use either the WSDL 1.1 or WSDL 2.0 description language.
endpoint
- endpoint reference; must be non-null.
null
if metadata
is unavailable.
JBIException
- invalid endpoint reference.public ServiceEndpoint[] getEndpoints(javax.xml.namespace.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.
public ServiceEndpoint[] getEndpointsForService(javax.xml.namespace.QName serviceName)
registerExternalEndpoint(ServiceEndpoint)
.
serviceName
- qualified name of the service that the endpoints
are part of; must be non-null.
public ServiceEndpoint[] getExternalEndpoints(javax.xml.namespace.QName interfaceName)
registerExternalEndpoint(ServiceEndpoint)
.
interfaceName
- qualified name of interface implemented by the
endpoints; must be non-null.
public ServiceEndpoint[] getExternalEndpointsForService(javax.xml.namespace.QName serviceName)
serviceName
- qualified name of service that contains the endpoints;
must be non-null.
public java.lang.String getInstallRoot()
This method MUST return the file path formatted for the underlying platform.
public java.util.logging.Logger getLogger(java.lang.String suffix, java.lang.String resourceBundleName) throws java.util.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.
java.util.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.public MBeanNames getMBeanNames()
public javax.management.MBeanServer getMBeanServer()
public javax.naming.InitialContext getNamingContext()
InitialContext
but its content will vary
based on the environment in which the JBI implementation is running.
public java.lang.Object getTransactionManager()
null
.
The object returned by this method is untyped, to allow this interface
to be compiled in environments that do not support JTA. If not null, the
object returned must be of type
javax.transaction.TransactionManager
.
This downcast is necessary because JBI is used in environments that do not support JTA (i.e., J2SE). Explicit use of JTA types would cause compilation failures in such environments.
null
if none
is available in the execution environment.public java.lang.String getWorkspaceRoot()
This method MUST return the file path formatted for the underlying platform.
The returned value must indicate a valid file path that the component may use to write files to, and read files from.
|
Built 06/07/2005 11:16 AM on acer (SunOS 5.9) | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |