FileDocCategorySizeDatePackage
WebServiceMgr.javaAPI DocGlassfish v2 API9930Fri May 04 22:30:50 BST 2007com.sun.appserv.management.ext.wsmgmt

WebServiceMgr

public interface WebServiceMgr implements com.sun.appserv.management.base.Singleton, com.sun.appserv.management.base.AMX
WebServiceMgr is used to obtained information about web service end points that are deployed. For each web service end point, name, URI, type of web service implementation (EJB or Servlet), EJB or Servlet name, descriptor locations etc. can be obtained.
This WebServiceMgr can also be used to create Self Management rules.
since
AppServer 9.0

Fields Summary
public static final String
J2EE_TYPE
The j2eeType of WebServiceMgr
public static final String
ALL_SERVERS
A constant to denote all servers.
public static final String
LB_HOST_KEY
host name or ip address of the loadbalancer where this service is publicly exposed
public static final String
LB_PORT_KEY
loadbalancer port used to expose this service
public static final String
LB_SECURE_PORT
secure port in loadbalancer used to expose this service
public static final String
CATEGORIES_KEY
Categories under which this web service endpoint should be published. This is an array of Strings.
public static final String
DESCRIPTION_KEY
Description of the web service endpoint
public static final String
ORGANIZATION_KEY
Organization Name under which the webservice should be published. Required for a UDDI registry.
public static final String
PUBLISH_URL_KEY
URL of the registry where publish requests are dispatched This is converted internally by the connector to JAXR implementation specific property javax.xml.registry.lifeCycleManagerURL
public static final String
QUERY_URL_KEY
public static final String
USERNAME_KEY
Username to publish to registry
public static final String
PASSWORD_KEY
Password to publish to registry
public static final String
UDDI_KEY
public static final String
EBXML_KEY
Constructors Summary
Methods Summary
public voidaddRegistryConnectionResources(java.lang.String jndiName, java.lang.String description, java.lang.String type, java.util.Map properties)
Adds registry specific resources to the domain. Adds a connector connection pool and then proceeds to add a connector resource

param
jndiName of the connector-resource that points to the registry
param
description of the connector-resource and the connector-connection-pool name
param
type type of registry: {@link #UDDI_KEY}, {@link #EBXML_KEY}
param
properties a map of key, value pair that encapsulate the properties of the connection pool that connects to the registry. Properties are {@link #PUBLISH_URL_KEY}, {@link #QUERY_URL_KEY}, {@link #USERNAME_KEY},{@link #PASSWORD_KEY}

public WebServiceEndpointInfogetWebServiceEndpointInfo(java.lang.Object key)
Returns the {@link WebServiceEndpointInfo} for a web service endpoint.

param
key The web service endpoint's key. This is opaque key. This is of form ApplicationID#ModuleID#WebServiceEndpointName or ModuleID#WebServiceEndpointName This is returned from getWebServiceEndpointKeys
return
{@link WebServiceEndpointInfo} as Map which is mapped by keys in interface {@link WebServiceEndpointInfo}
deprecated
should not use proprietary types over the wire

public java.util.MapgetWebServiceEndpointKeys()
Returns a map of web service endpoint keys and their display names. It returns information for all deployed web service endpoints in the domain.

return
a map of web service endpoint keys and their display names This returned key is opaque. This is of form ApplicationID#ModuleID#WebServiceEndpointName or ModuleID#WebServiceEndpointName

public java.util.SetgetWebServiceEndpointSet(java.lang.Object webServiceEndpointKey, java.lang.String serverName)
Returns the set of {@link WebServiceEndpoint} runtime mbeans for the specified Web Service Endpoint key on the specified server instance.

param
webServiceEndpointKey Web Service Endpoint Key
param
serverName Name of the server instance. To specify all server instances, use {@link #ALL_SERVERS}
return
Set of WebServiceEndpoint runtime mbeans

public java.lang.String[]listRegistryLocations()
Returns list of configured web service registry access points.

return
list of configured web service registry access points

public voidpublishToRegistry(java.lang.String[] registryLocations, java.lang.Object webServiceEndpointKey, java.util.Map optional)
Publishes the WSDL of webService to the registries specified by the JNDI Names

param
registryLocations array of jndi names of the connector resources pointing to different registries
param
webServiceEndpointKey web service endpoint(key) whose WSDL has to be published; format is appName#moduleName#webserviceName This is opaque, as returned by the method getWebServiceEndpointKeys
param
optional map contains the following:
lbhost, host name or ip address of the loadbalancer where this
service is publicly exposed
lbport, loadbalancer port used to expose this service
lbsslport, secure port in loadbalancer used to expose this service
categories, Categories under which this web service endpoint should be
published. This is an array of Strings.
description, Description of the web service endpoint
organization, Name of the Organization that the web service should be
published under.

public voidremoveRegistryConnectionResources(java.lang.String jndiNameOfRegistry)

public voidunpublishFromRegistry(java.lang.String[] registryLocations, java.lang.Object webServiceEndpointKey)
Unpublish WSDL of the specified webservice from the registries specified via their JNDI names

param
registryLocations array of jndi names of the connector resources pointing to different registries
param
webServiceEndpointKey web service endpoint(key) whose WSDL has to be published; format is appName#moduleName#webserviceName This is opaque, as returned by the method getWebServiceEndpointKeys