|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface provides configuration operations for the WebServices Gateway. This interface is intended to be implemented by a stateless session bean to provide indirect access to the Gateway Manager.
Field Summary | |
static java.lang.String |
copyright
Copyright string. |
Method Summary | |
void |
addChannel(ChannelState channelState)
Creates a new named channel definition. |
void |
addChannelForService(java.lang.String gatewayServiceName,
java.lang.String channelName)
Makes the given gateway service available on the given channel. |
void |
addFilter(FilterState filterState)
Creates a new named filter definition. |
void |
addFilterForService(java.lang.String gatewayServiceName,
java.lang.String filterName,
int position,
boolean preFilter)
Adds the given filter to the list for the given gateway service. |
void |
addGatewayService(java.lang.String gatewayServiceName)
Adds the gateway service with the given name and default attributes. |
void |
addTargetService(java.lang.String gatewayServiceName,
TargetServiceState targetServiceState)
Adds the given target service to the set which are mapped to by the given gateway service. |
void |
addUDDIReference(UDDIReferenceState referenceState)
Creates a new named UDDI reference definition. |
void |
addUDDIReferenceForService(java.lang.String gatewayServiceName,
java.lang.String referenceName)
Adds the given UDDI reference to the set of those to which the given gateway service is to be published. |
ChannelState |
getChannel(java.lang.String channelName)
Returns the state for a named channel definition. |
java.lang.String[] |
getChannelNames()
Returns the list of names of channel instances. |
java.lang.String[] |
getChannelNames(java.lang.String gatewayServiceName)
Returns the list of names of channel instances for the given gateway service. |
java.lang.String |
getDefaultUDDIProviderDesc()
Returns the default provider name to be used when publishing services to UDDI. |
java.lang.String |
getDefaultUDDIProviderName()
Returns the default provider name to be used when publishing services to UDDI. |
java.lang.String |
getExportedImplementationDefinition(java.lang.String gatewayServiceName)
Returns the exported WSDL implementation definition for the given gateway service. |
java.lang.String |
getExportedInterfaceDefinition(java.lang.String gatewayServiceName)
Returns the exported WSDL interface definition for the given gateway service. |
FilterState |
getFilter(java.lang.String filterName)
Returns the state for a named filter definition. |
java.lang.String[] |
getFilterNames()
Returns the list of names of filter instances. |
java.lang.String[] |
getFilterNames(java.lang.String gatewayServiceName,
boolean preFilter)
Returns the list of names of filter instances for the given gateway service. |
GatewayServiceState |
getGatewayService(java.lang.String gatewayServiceName)
Returns the attributes of the specified gateway service. |
java.lang.String[] |
getGatewayServiceNames()
Returns the list of names of gateway services. |
java.lang.String |
getGatewayURI()
Returns the URI to be used to access servlets the Gateway web application. |
java.lang.String |
getImportedDocument(java.lang.String gatewayServiceName,
java.lang.String importURL)
Returns the imported document for the given gateway service. |
int |
getMessageLevel()
Returns the level of messages to be produced by the gateway. |
java.lang.String |
getNamespaceURI()
Returns the URI used to generate the external names of gateway services. |
TargetServiceState |
getTargetService(java.lang.String gatewayServiceName,
TargetServiceLocation targetServiceLocation)
Gets the given target service from the set which are mapped to by the given gateway service. |
TargetServiceLocation[] |
getTargetServiceLocations(java.lang.String gatewayServiceName)
Returns the list of locations of target services for the given gateway service. |
UDDIReferenceState |
getUDDIReference(java.lang.String referenceName)
Returns the given named UDDI reference definition. |
java.lang.String[] |
getUDDIReferenceNames()
Returns the list of names of UDDI references. |
java.lang.String[] |
getUDDIReferenceNames(java.lang.String gatewayServiceName)
Returns the list of names of UDDI reference names for the given gateway service. |
java.lang.String |
getWarehouseURL()
Returns the URL used by the default message warehouse service for storing messages. |
void |
removeChannel(java.lang.String channelName,
boolean force,
boolean stopChannel)
Removes a named channel definition. |
void |
removeChannelForService(java.lang.String gatewayServiceName,
java.lang.String channelName)
Stops the given gateway service from being available on the given channel. |
void |
removeFilter(java.lang.String filterName,
boolean force)
Removes a named filter definition. |
void |
removeFilterForService(java.lang.String gatewayServiceName,
java.lang.String filterName,
int position,
boolean preFilter)
Removes the given filter from the given gateway service. |
void |
removeGatewayService(java.lang.String gatewayServiceName,
boolean force)
Removes the specified gateway service. |
void |
removeTargetService(java.lang.String gatewayServiceName,
TargetServiceLocation targetServiceLocation)
Removes the given target service from the set which are mapped to by the given gateway service. |
void |
removeUDDIReference(java.lang.String referenceName,
boolean force)
Removes the given named UDDI reference definition. |
void |
removeUDDIReferenceForService(java.lang.String gatewayServiceName,
java.lang.String referenceName)
Removes the given UDDI reference from the set to which the given gateway service is to be published. |
void |
setChannel(ChannelState channelState)
Updates a channel definition. |
void |
setDefaultUDDIProviderDesc(java.lang.String defaultUDDIProviderDesc)
Sets the default provider descriptipon to be used when publishing services to UDDI. |
void |
setDefaultUDDIProviderName(java.lang.String defaultUDDIProviderName)
Sets the default provider name to be used when publishing services to UDDI. |
void |
setFilter(FilterState filterState)
Updates a filter definition. |
void |
setGatewayService(GatewayServiceState gatewayServiceState)
Sets the attributes of the specified gateway service to the specified values. |
void |
setGatewayURI(java.lang.String gatewayURI)
Sets the URI to be used to access servlets the Gateway web application. |
void |
setMessageLevel(int messageLevel)
Sets the level of messages to be produced by the gateway. |
void |
setNamespaceURI(java.lang.String namespaceURI)
Sets the URI to be used to generate the external names of gateway services. |
void |
setTargetService(java.lang.String gatewayServiceName,
TargetServiceState targetServiceState)
Sets the attributes of the given target service. |
void |
setUDDIReference(UDDIReferenceState referenceState)
Updates the values for an existing named UDDI reference definition. |
void |
setWarehouseURL(java.lang.String warehouseURL)
Sets the URL to be used by the default message warehouse service for storing messages. |
Field Detail |
public static final java.lang.String copyright
Method Detail |
public void addGatewayService(java.lang.String gatewayServiceName) throws WSGWException, java.rmi.RemoteException
gatewayServiceName
- The gateway service name.WSGWException
- An error occurred.java.rmi.RemoteException
- Required for EJB remote interfaces.public void setGatewayService(GatewayServiceState gatewayServiceState) throws WSGWException, java.rmi.RemoteException
Gateway services are created automatically when required, with default values for the attributes. This method can be used to set non-default values.
If the gateway service does not already exist then it is created.
gatewayServiceState
- The gateway service state.WSGWException
- An error occurred.java.rmi.RemoteException
- Required for EJB remote interfaces.public GatewayServiceState getGatewayService(java.lang.String gatewayServiceName) throws WSGWException, java.rmi.RemoteException
gatewayServiceName
- The gateway service name.WSGWException
- An error occurred.java.rmi.RemoteException
- Required for EJB remote interfaces.public void removeGatewayService(java.lang.String gatewayServiceName, boolean force) throws WSGWException, java.rmi.RemoteException
The force parameter indicates whether to remove the gateway service even if it has active channels, filters, target services and/or UDDI references. If any are active, any UDDI entries are removed, then all filters, channels target services and UDDI registries are cleaned up.
gatewayServiceName
- The gateway service name.force
- Force removal even if there are entites defined for the service.WSGWException
- The named service does not exist, or has active channels,
filters, target services and/or UDDI references and the force parameter is
set to "false".java.rmi.RemoteException
- Required for EJB remote interfaces.public void addChannelForService(java.lang.String gatewayServiceName, java.lang.String channelName) throws WSGWException, java.rmi.RemoteException
If this is the first channel for the gateway service, and there is a target service defined, then the service is published to the current set of UDDI registries for the gateway service.
If the gateway service or channel do not exist, or the service is already available on the given channel then a WSGWException is thrown.
gatewayServiceName
- The gateway service name.channelName
- The channel instance name.WSGWException
- The named service or channel does not exist, or the
channel has already been defined for the service.java.rmi.RemoteException
- Required for EJB remote interfaces.public void removeChannelForService(java.lang.String gatewayServiceName, java.lang.String channelName) throws WSGWException, java.rmi.RemoteException
If this is the last channel for the service, and there is a target service defined, then the service is removed from the current set of UDDI registries for the gateway service.
If the resulting set of channels for the gateway service is empty, then the gateway service itself is not removed until the removeGatewayService method is called, unless the gateway service has all default attribute values, no UDDI references and no target services.
gatewayServiceName
- The gateway service name.channelName
- The channel instance name.WSGWException
- The named service or channel does not exist, or the
channel has not been defined for the service.java.rmi.RemoteException
- Required for EJB remote interfaces.public void addUDDIReferenceForService(java.lang.String gatewayServiceName, java.lang.String referenceName) throws WSGWException, java.rmi.RemoteException
If the set of channels for the gateway service is not empty, and there is a target service, then gateway service is published to the UDDI registry represented by the given reference.
gatewayServiceName
- The gateway service name.referenceName
- The UDDI reference name.WSGWException
- The named service or UDDI reference does not exist,
or the UDDI reference has already been defined for the service.java.rmi.RemoteException
- Required for EJB remote interfaces.public void removeUDDIReferenceForService(java.lang.String gatewayServiceName, java.lang.String referenceName) throws WSGWException, java.rmi.RemoteException
If the set of channels and the set of target services for the gateway service are not empty, then the service is removed from the UDDI registry corresponding to the given reference.
gatewayServiceName
- The gateway service name.referenceName
- The UDDI reference name.WSGWException
- The named service or UDDI reference does not exist,
or the UDDI reference has not been defined for the service.java.rmi.RemoteException
- Required for EJB remote interfaces.public void addFilterForService(java.lang.String gatewayServiceName, java.lang.String filterName, int position, boolean preFilter) throws WSGWException, java.rmi.RemoteException
The preFilter parameter determines whether the filter is added to the list of pre-filters or post-filters for the service.
The position parameter indicates the position in the current list of filters that the new one should take. 0 indicates the top of the list, -1 indicates the end of the list, any other number indicates the number of current filters which should remain ahead of the new filter. If the number is greater than the size of the list then the filter is added to the end.
gatewayServiceName
- The gateway service name.filterName
- The filter instance name.position
- The position for the filter.preFilter
- Indicates pre- or post- filter.WSGWException
- The named service or filter does not exist,
the position is invalid or the filter has already been defined for the service.java.rmi.RemoteException
- Required for EJB remote interfaces.public void removeFilterForService(java.lang.String gatewayServiceName, java.lang.String filterName, int position, boolean preFilter) throws WSGWException, java.rmi.RemoteException
The preFilter parameter determines whether the filter is removed from the list of pre-filters or post-filters for the service.
gatewayServiceName
- The gateway service name.filterName
- The filter instance name. If null uses positionposition
- The filter position on the service. if -1, uses filterNamepreFilter
- Indicates pre- or post- filter.WSGWException
- The named service or filter does not exist,
or the filter has not been defined for the service.java.rmi.RemoteException
- Required for EJB remote interfaces.public void addTargetService(java.lang.String gatewayServiceName, TargetServiceState targetServiceState) throws WSGWException, java.rmi.RemoteException
If the gateway service does not exist, then one is created with default attributes.
The parameters provide the information necessary to locate the target service's WSDL definition, and to identify the specific service in that WSDL definition. If this is the first target service for the gateway service and there are any channels and any UDDI references for the gateway service then the definition is rebound and published.
gatewayServiceName
- The gateway service name.targetServiceState
- The target service state.WSGWException
- The named service does not exist, or the target
service has already been defined for the service.java.rmi.RemoteException
- Required for EJB remote interfaces.public TargetServiceState getTargetService(java.lang.String gatewayServiceName, TargetServiceLocation targetServiceLocation) throws WSGWException, java.rmi.RemoteException
gatewayServiceName
- The gateway service name.targetServiceLocation
- The target service location.WSGWException
- The named service does not exist.java.rmi.RemoteException
- Required for EJB remote interfaces.public void setTargetService(java.lang.String gatewayServiceName, TargetServiceState targetServiceState) throws WSGWException, java.rmi.RemoteException
gatewayServiceName
- The gateway service name.targetServiceState
- The target service state.WSGWException
- The named service does not exist.java.rmi.RemoteException
- Required for EJB remote interfaces.public void removeTargetService(java.lang.String gatewayServiceName, TargetServiceLocation targetServiceLocation) throws WSGWException, java.rmi.RemoteException
If there are no target services for the gateway service after the removal, then the service is removed from any UDDI registries corresponding to UDDI references for the gateway service, if any.
gatewayServiceName
- The gateway service name.targetServiceLocation
- The target service location.WSGWException
- The named service does not exist, or the target
service has not been defined for the service.java.rmi.RemoteException
- Required for EJB remote interfaces.public void addChannel(ChannelState channelState) throws WSGWException, java.rmi.RemoteException
The parameters provide the information necessary to locate the channel's implementation.
channelState
- The channel state.WSGWException
- The named channel already exists, or could not
be located.java.rmi.RemoteException
- Required for EJB remote interfaces.public ChannelState getChannel(java.lang.String channelName) throws WSGWException, java.rmi.RemoteException
channelName
- The name of the channel.WSGWException
- The named channel does not exist.java.rmi.RemoteException
- Required for EJB remote interfaces.public void setChannel(ChannelState channelState) throws WSGWException, java.rmi.RemoteException
channelState
- The channel state.WSGWException
- The named channel does not exist.java.rmi.RemoteException
- Required for EJB remote interfaces.public void removeChannel(java.lang.String channelName, boolean force, boolean stopChannel) throws WSGWException, java.rmi.RemoteException
The force parameter indicates whether to remove the channel even if it has been added to gateway services. In that case, the channel is first removed from all gateway services for which it is defined (with the possible resulting updates/removals of the exported gateway service definition from UDDI registries), and then is itself removed.
channelName
- The name of the channel.force
- Force removal even if there are services defined for the channel.stopChannel
- Indicates whether the channel should be stopped.WSGWException
- The named channel does not exist, or it already
exists with active gateway services and the force parameter was "false".
be located.java.rmi.RemoteException
- Required for EJB remote interfaces.public void addFilter(FilterState filterState) throws WSGWException, java.rmi.RemoteException
The parameters provide the information necessary to locate the filter's implementation.
filterState
- The filter state.WSGWException
- The named filter already exists, or could not
be located.java.rmi.RemoteException
- Required for EJB remote interfaces.public FilterState getFilter(java.lang.String filterName) throws WSGWException, java.rmi.RemoteException
filterName
- The filter instance name.WSGWException
- The named filter does not exist.java.rmi.RemoteException
- Required for EJB remote interfaces.public void setFilter(FilterState filterState) throws WSGWException, java.rmi.RemoteException
filterState
- The filter state.WSGWException
- The named filter does not exist.java.rmi.RemoteException
- Required for EJB remote interfaces.public void removeFilter(java.lang.String filterName, boolean force) throws WSGWException, java.rmi.RemoteException
The force parameter indicates whether to remove the filter even if it has been added to gateway services. In that case, the filter is first removed from all gateway services for which it is defined, and then is itself removed.
filterName
- The filter instance name.force
- Force removal even if there are services defined for the filter.WSGWException
- The named filter does not exist, or it already
exists with active gateway services and the force parameter was "false".java.rmi.RemoteException
- Required for EJB remote interfaces.public void addUDDIReference(UDDIReferenceState referenceState) throws WSGWException, java.rmi.RemoteException
The parameters provide the information necessary to locate and interact with a particular UDDI registry.
referenceState
- The UDDI reference state.WSGWException
- The named reference already exists.java.rmi.RemoteException
- Required for EJB remote interfaces.public void setUDDIReference(UDDIReferenceState referenceState) throws WSGWException, java.rmi.RemoteException
The parameters provide the information necessary to locate and interact with a particular UDDI registry.
referenceState
- The UDDI reference state.WSGWException
- The named reference does not exist.java.rmi.RemoteException
- Required for EJB remote interfaces.public UDDIReferenceState getUDDIReference(java.lang.String referenceName) throws WSGWException, java.rmi.RemoteException
referenceName
- The UDDI reference name.WSGWException
- The named reference does not exist.java.rmi.RemoteException
- Required for EJB remote interfaces.public void removeUDDIReference(java.lang.String referenceName, boolean force) throws WSGWException, java.rmi.RemoteException
The force parameter indicates whether to remove the UDDI reference even if it has been added to gateway services. In that case, the UDDI reference is first removed from all gateway services for which it is defined (with the possible resulting removals of the exported gateway service definition from the corresponding UDDI registry), and then is itself removed.
referenceName
- The UDDI reference name.force
- Force removal even if there are services defined for the reference.WSGWException
- The named reference does not exist, or it already
exists with active gateway services and the force parameter was "false".java.rmi.RemoteException
- Required for EJB remote interfaces.public java.lang.String getExportedImplementationDefinition(java.lang.String gatewayServiceName) throws WSGWException, java.rmi.RemoteException
gatewayServiceName
- The gateway service name.WSGWException
- The gateway service does not exist, there are no target
services for the gateway service or the target service definition could not be located.java.rmi.RemoteException
- Required for EJB remote interfaces.public java.lang.String getExportedInterfaceDefinition(java.lang.String gatewayServiceName) throws WSGWException, java.rmi.RemoteException
gatewayServiceName
- The gateway service name.WSGWException
- The gateway service does not exist, there are no target
services for the gateway service or the target service definition could not be located.java.rmi.RemoteException
- Required for EJB remote interfaces.public java.lang.String getImportedDocument(java.lang.String gatewayServiceName, java.lang.String importURL) throws WSGWException, java.rmi.RemoteException
gatewayServiceName
- The gateway service name.importURL
- The import location.WSGWException
- The gateway service does not exist, there are no target
services for the gateway service or the target service definition could not be located.java.rmi.RemoteException
- Required for EJB remote interfaces.public java.lang.String[] getGatewayServiceNames() throws WSGWException, java.rmi.RemoteException
- WSGWException
- An error occurred.java.rmi.RemoteException
- Required for EJB remote interfaces.public java.lang.String[] getChannelNames() throws WSGWException, java.rmi.RemoteException
- WSGWException
- An error occurred.java.rmi.RemoteException
- Required for EJB remote interfaces.public java.lang.String[] getFilterNames() throws WSGWException, java.rmi.RemoteException
- WSGWException
- An error occurred.java.rmi.RemoteException
- Required for EJB remote interfaces.public java.lang.String[] getUDDIReferenceNames() throws WSGWException, java.rmi.RemoteException
- WSGWException
- An error occurred.java.rmi.RemoteException
- Required for EJB remote interfaces.public TargetServiceLocation[] getTargetServiceLocations(java.lang.String gatewayServiceName) throws WSGWException, java.rmi.RemoteException
The result is an array of strings of the form: service name:location (the service name never contains a colon as it is an NCNAME).
gatewayServiceName
- The gateway service name.WSGWException
- The gateway service does not exist.java.rmi.RemoteException
- Required for EJB remote interfaces.public java.lang.String[] getChannelNames(java.lang.String gatewayServiceName) throws WSGWException, java.rmi.RemoteException
gatewayServiceName
- The gateway service name.WSGWException
- The gateway service does not exist.java.rmi.RemoteException
- Required for EJB remote interfaces.public java.lang.String[] getFilterNames(java.lang.String gatewayServiceName, boolean preFilter) throws WSGWException, java.rmi.RemoteException
The preFilter parameter determines whether the filters are from the list of pre-filters or post-filters for the service.
gatewayServiceName
- The gateway service name.preFilter
- Indicates pre- or post- filters.WSGWException
- The gateway service does not exist.java.rmi.RemoteException
- Required for EJB remote interfaces.public java.lang.String[] getUDDIReferenceNames(java.lang.String gatewayServiceName) throws WSGWException, java.rmi.RemoteException
gatewayServiceName
- The gateway service name.WSGWException
- The gateway service does not exist.java.rmi.RemoteException
- Required for EJB remote interfaces.public void setNamespaceURI(java.lang.String namespaceURI) throws WSGWException, java.rmi.RemoteException
Changing this value does not affect existing published services.
namespaceURI
- The new value.WSGWException
- An error occurred setting the value.java.rmi.RemoteException
- Required for EJB remote interfaces.public java.lang.String getNamespaceURI() throws java.rmi.RemoteException
- java.rmi.RemoteException
- Required for EJB remote interfaces.public void setGatewayURI(java.lang.String gatewayURI) throws WSGWException, java.rmi.RemoteException
gatewayURI
- The new value.WSGWException
- An error occurred setting the value.java.rmi.RemoteException
- Required for EJB remote interfaces.public java.lang.String getGatewayURI() throws java.rmi.RemoteException
- java.rmi.RemoteException
- Required for EJB remote interfaces.public void setMessageLevel(int messageLevel) throws WSGWException, java.rmi.RemoteException
messageLevel
- The new level.WSGWException
- An error occurred setting the value.java.rmi.RemoteException
- Required for EJB remote interfaces.public int getMessageLevel() throws java.rmi.RemoteException
- java.rmi.RemoteException
- Required for EJB remote interfaces.public void setWarehouseURL(java.lang.String warehouseURL) throws WSGWException, java.rmi.RemoteException
warehouseURL
- The new value.WSGWException
- An error occurred setting the value.java.rmi.RemoteException
- Required for EJB remote interfaces.public java.lang.String getWarehouseURL() throws java.rmi.RemoteException
- java.rmi.RemoteException
- Required for EJB remote interfaces.public void setDefaultUDDIProviderName(java.lang.String defaultUDDIProviderName) throws WSGWException, java.rmi.RemoteException
defaultUDDIProviderName
- The new value.WSGWException
- An error occurred setting the value.java.rmi.RemoteException
- Required for EJB remote interfaces.public java.lang.String getDefaultUDDIProviderName() throws java.rmi.RemoteException
- java.rmi.RemoteException
- Required for EJB remote interfaces.public void setDefaultUDDIProviderDesc(java.lang.String defaultUDDIProviderDesc) throws WSGWException, java.rmi.RemoteException
defaultUDDIProviderDesc
- The new value.WSGWException
- An error occurred setting the value.java.rmi.RemoteException
- Required for EJB remote interfaces.public java.lang.String getDefaultUDDIProviderDesc() throws java.rmi.RemoteException
- java.rmi.RemoteException
- Required for EJB remote interfaces.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |