com.sun.appserv.management.ext.wsmgmt
Interface WebServiceMgr

All Superinterfaces:

AMX, AMXMBeanLogging, NotificationBroadcaster, NotificationEmitter, Singleton

public interface WebServiceMgr
extends AMX, Singleton

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

Field Summary

static String	ALL_SERVERS A constant to denote all servers.
static String	CATEGORIES_KEY Categories under which this web service endpoint should be published.
static String	DESCRIPTION_KEY Description of the web service endpoint
static String	EBXML_KEY
static String	J2EE_TYPE The j2eeType of WebServiceMgr
static String	LB_HOST_KEY host name or ip address of the loadbalancer where this service is publicly exposed
static String	LB_PORT_KEY loadbalancer port used to expose this service
static String	LB_SECURE_PORT secure port in loadbalancer used to expose this service
static String	ORGANIZATION_KEY Organization Name under which the webservice should be published.
static String	PASSWORD_KEY Password to publish to registry
static 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
static String	QUERY_URL_KEY
static String	UDDI_KEY
static String	USERNAME_KEY Username to publish to registry

Fields inherited from interface com.sun.appserv.management.base.AMX

FULL_TYPE_DELIM, GROUP_CONFIGURATION, GROUP_JSR77, GROUP_MONITORING, GROUP_OTHER, GROUP_UTILITY, J2EE_TYPE_KEY, JMX_DOMAIN, NAME_KEY, NO_NAME, NOTIFICATION_PREFIX, NULL_NAME

Method Summary

void	addRegistryConnectionResources(String jndiName, String description, String type, Map<String,String> properties) Adds registry specific resources to the domain.
WebServiceEndpointInfo	getWebServiceEndpointInfo(Object key) Deprecated. should not use proprietary types over the wire
Map<Object,String>	getWebServiceEndpointKeys() Returns a map of web service endpoint keys and their display names.
Set<WebServiceEndpoint>	getWebServiceEndpointSet(Object webServiceEndpointKey, String serverName) Returns the set of WebServiceEndpoint runtime mbeans for the specified Web Service Endpoint key on the specified server instance.
String[]	listRegistryLocations() Returns list of configured web service registry access points.
void	publishToRegistry(String[] registryLocations, Object webServiceEndpointKey, Map<String,String> optional) Publishes the WSDL of webService to the registries specified by the JNDI Names
void	removeRegistryConnectionResources(String jndiNameOfRegistry)
void	unpublishFromRegistry(String[] registryLocations, Object webServiceEndpointKey) Unpublish WSDL of the specified webservice from the registries specified via their JNDI names

Methods inherited from interface com.sun.appserv.management.base.AMX

getContainer, getDomainRoot, getFullType, getGroup, getJ2EEType, getName, isDAS

Methods inherited from interface javax.management.NotificationEmitter

removeNotificationListener

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface com.sun.appserv.management.base.AMXMBeanLogging

getMBeanLoggerName, getMBeanLogLevel, setMBeanLogLevel

Field Detail

J2EE_TYPE

static final String J2EE_TYPE

The j2eeType of WebServiceMgr

See Also:

Constant Field Values

ALL_SERVERS

static final String ALL_SERVERS

A constant to denote all servers.

See Also:

Constant Field Values

LB_HOST_KEY

static final String LB_HOST_KEY

host name or ip address of the loadbalancer where this service is publicly exposed

See Also:

Constant Field Values

LB_PORT_KEY

static final String LB_PORT_KEY

loadbalancer port used to expose this service

See Also:

Constant Field Values

LB_SECURE_PORT

static final String LB_SECURE_PORT

secure port in loadbalancer used to expose this service

See Also:

Constant Field Values

CATEGORIES_KEY

static final String CATEGORIES_KEY

Categories under which this web service endpoint should be published. This is an array of Strings.

See Also:

Constant Field Values

DESCRIPTION_KEY

static final String DESCRIPTION_KEY

Description of the web service endpoint

See Also:

Constant Field Values

ORGANIZATION_KEY

static final String ORGANIZATION_KEY

Organization Name under which the webservice should be published. Required for a UDDI registry.

See Also:

Constant Field Values

PUBLISH_URL_KEY

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

See Also:

Constant Field Values

QUERY_URL_KEY

static final String QUERY_URL_KEY

See Also:

Constant Field Values

USERNAME_KEY

static final String USERNAME_KEY

Username to publish to registry

See Also:

Constant Field Values

PASSWORD_KEY

static final String PASSWORD_KEY

Password to publish to registry

See Also:

Constant Field Values

UDDI_KEY

static final String UDDI_KEY

See Also:

Constant Field Values

EBXML_KEY

static final String EBXML_KEY

See Also:

Constant Field Values

Method Detail

getWebServiceEndpointKeys

Map<Object,String> getWebServiceEndpointKeys()

Returns a map of web service endpoint keys and their display names. It returns information for all deployed web service endpoints in the domain.

Returns:

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

getWebServiceEndpointInfo

WebServiceEndpointInfo getWebServiceEndpointInfo(Object key)

Deprecated. should not use proprietary types over the wire

Returns the WebServiceEndpointInfo for a web service endpoint.

Parameters:

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

Returns:

WebServiceEndpointInfo as Map which is mapped by keys in interface WebServiceEndpointInfo

getWebServiceEndpointSet

Set<WebServiceEndpoint> getWebServiceEndpointSet(Object webServiceEndpointKey,
                                                 String serverName)

Returns the set of WebServiceEndpoint runtime mbeans for the specified Web Service Endpoint key on the specified server instance.

Parameters:

webServiceEndpointKey - Web Service Endpoint Key

serverName - Name of the server instance. To specify all server instances, use ALL_SERVERS

Returns:

Set of WebServiceEndpoint runtime mbeans

listRegistryLocations

String[] listRegistryLocations()

Returns list of configured web service registry access points.

Returns:

list of configured web service registry access points

publishToRegistry

void publishToRegistry(String[] registryLocations,
                       Object webServiceEndpointKey,
                       Map<String,String> optional)

Publishes the WSDL of webService to the registries specified by the JNDI Names

Parameters:

registryLocations - array of jndi names of the connector resources pointing to different registries

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

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.
 

unpublishFromRegistry

void unpublishFromRegistry(String[] registryLocations,
                           Object webServiceEndpointKey)

Unpublish WSDL of the specified webservice from the registries specified via their JNDI names

Parameters:

registryLocations - array of jndi names of the connector resources pointing to different registries

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

removeRegistryConnectionResources

void removeRegistryConnectionResources(String jndiNameOfRegistry)

addRegistryConnectionResources

void addRegistryConnectionResources(String jndiName,
                                    String description,
                                    String type,
                                    Map<String,String> properties)

Adds registry specific resources to the domain. Adds a connector connection pool and then proceeds to add a connector resource

Parameters:

jndiName - of the connector-resource that points to the registry

description - of the connector-resource and the connector-connection-pool name

type - type of registry: UDDI_KEY, EBXML_KEY

properties - a map of key, value pair that encapsulate the properties of the connection pool that connects to the registry. Properties are PUBLISH_URL_KEY, QUERY_URL_KEY, USERNAME_KEY,PASSWORD_KEY