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

All Superinterfaces:

MapCapable

All Known Implementing Classes:

WebServiceEndpointInfoImpl

public interface WebServiceEndpointInfo
extends MapCapable

WebServiceInfo provides information for a particular web service end point. Information includes name, URI, descriptor locations, type of implementation (EJB or Servlet), etc.

Since:

AppServer 9.0

Field Summary

static String	APP_ID_KEY Application ID
static String	APPLICATION_XML_KEY application.xml file
static String	BUNDLE_NAME_KEY Bundle (embedded module) name, if applicable
static String	CLASS_NAME This interface's class name
static String	EJB_IMPL EJB implementation type name
static String	EJB_XML_KEY ejb.xml file
static String	END_POINT_URI_KEY Relative end point URI
static String	IS_SECURE_KEY Decides if this web service end point is secured or not.
static String	IS_STAND_ALONE_MODULE_KEY Decides if this web service end point is in a stand alone Module or not.
static String	MAPPING_FILE_KEY Mapping file
static String	MAPPING_FILE_LOCATION_KEY Mapping file location
static String	NAME_KEY Name of the web service
static String	SERVICE_IMPL_CLASS_KEY EJB or Servlet class name
static String	SERVICE_IMPL_NAME_KEY EJB or Servlet name
static String	SERVICE_IMPL_TYPE_KEY Web service implementation type - @see #EJB_IMPL or @see #SERVLET_IMPL
static String	SERVLET_IMPL Servlet implementation type name
static String	SUN_EJB_XML_KEY ejb.xml file
static String	SUN_WEB_XML_KEY sun-web.xml file
static String	THROUGHPUT_STATISTIC Throuput statistic's name
static String	WEB_SERVICES_FILE_KEY webservices.xml file
static String	WEB_XML_KEY web.xml file
static String	WSDL_FILE_KEY WSDL file
static String	WSDL_FILE_LOCATION_KEY WSDL location file

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

MAP_CAPABLE_CLASS_NAME_KEY

Method Summary

String	getAppID() Returns the name of the application or stand alone module that has this web service.
String	getApplicationXML() Gets the application.xml file.
String	getBundleName() Returns the module name within a EAR or null if it is a stand alone module.
String[]	getDescriptors() Returns the descriptor .
String	getEJBXML() Gets the ejb.xml file.
String	getEndpointURI() Returns the relative URI of this endpoint.
String	getMappingFile() Returns the mapping file.
String	getName() Returns the name of the WebService.
String	getServiceImplClass() Returns the implementation Ejb or Servlet class name of this web service.
String	getServiceImplName() Returns the implementation Ejb or Servlet name of this web service.
String	getServiceImplType() Returns the implementation type of this web service.
String	getSunEJBXML() Gets the sun-ejb.xml file.
String	getSunWebXML() Gets the sun-web.xml file.
String	getWebservicesFile() Returns the webservices.xml file .
String	getWebXML() Gets the web.xml file.
String	getWSDLFile() Returns the WSDL file Corresponds to the WSDL_FILE_KEY key.
boolean	isAppStandaloneModule() Returns true if this web service belongs to a stand alone module.
boolean	isSecure() Returns true if this web service is secured or not.

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

asMap, getMapClassName

Field Detail

APP_ID_KEY

static final String APP_ID_KEY

Application ID

See Also:

Constant Field Values

NAME_KEY

static final String NAME_KEY

Name of the web service

See Also:

Constant Field Values

END_POINT_URI_KEY

static final String END_POINT_URI_KEY

Relative end point URI

See Also:

Constant Field Values

IS_STAND_ALONE_MODULE_KEY

static final String IS_STAND_ALONE_MODULE_KEY

Decides if this web service end point is in a stand alone Module or not.

See Also:

Constant Field Values

BUNDLE_NAME_KEY

static final String BUNDLE_NAME_KEY

Bundle (embedded module) name, if applicable

See Also:

Constant Field Values

SERVICE_IMPL_NAME_KEY

static final String SERVICE_IMPL_NAME_KEY

EJB or Servlet name

See Also:

Constant Field Values

SERVICE_IMPL_CLASS_KEY

static final String SERVICE_IMPL_CLASS_KEY

EJB or Servlet class name

See Also:

Constant Field Values

SERVICE_IMPL_TYPE_KEY

static final String SERVICE_IMPL_TYPE_KEY

Web service implementation type - @see #EJB_IMPL or @see #SERVLET_IMPL

See Also:

Constant Field Values

WSDL_FILE_KEY

static final String WSDL_FILE_KEY

WSDL file

See Also:

Constant Field Values

WEB_SERVICES_FILE_KEY

static final String WEB_SERVICES_FILE_KEY

webservices.xml file

See Also:

Constant Field Values

WSDL_FILE_LOCATION_KEY

static final String WSDL_FILE_LOCATION_KEY

WSDL location file

See Also:

Constant Field Values

MAPPING_FILE_KEY

static final String MAPPING_FILE_KEY

Mapping file

See Also:

Constant Field Values

MAPPING_FILE_LOCATION_KEY

static final String MAPPING_FILE_LOCATION_KEY

Mapping file location

See Also:

Constant Field Values

APPLICATION_XML_KEY

static final String APPLICATION_XML_KEY

application.xml file

See Also:

Constant Field Values

WEB_XML_KEY

static final String WEB_XML_KEY

web.xml file

See Also:

Constant Field Values

EJB_XML_KEY

static final String EJB_XML_KEY

ejb.xml file

See Also:

Constant Field Values

SUN_WEB_XML_KEY

static final String SUN_WEB_XML_KEY

sun-web.xml file

See Also:

Constant Field Values

SUN_EJB_XML_KEY

static final String SUN_EJB_XML_KEY

ejb.xml file

See Also:

Constant Field Values

EJB_IMPL

static final String EJB_IMPL

EJB implementation type name

See Also:

Constant Field Values

SERVLET_IMPL

static final String SERVLET_IMPL

Servlet implementation type name

See Also:

Constant Field Values

CLASS_NAME

static final String CLASS_NAME

This interface's class name

See Also:

Constant Field Values

THROUGHPUT_STATISTIC

static final String THROUGHPUT_STATISTIC

Throuput statistic's name

See Also:

Constant Field Values

IS_SECURE_KEY

static final String IS_SECURE_KEY

Decides if this web service end point is secured or not.

See Also:

Constant Field Values

Method Detail

getName

String getName()

Returns the name of the WebService. Corresponds to the NAME_KEY key.

Returns:

fully qualified name of this WebService

getEndpointURI

String getEndpointURI()

Returns the relative URI of this endpoint. Corresponds to the END_POINT_URI_KEY key.

Returns:

the uri string

getAppID

String getAppID()

Returns the name of the application or stand alone module that has this web service. Corresponds to the APP_ID_KEY key.

Returns:

the Application Id

isAppStandaloneModule

boolean isAppStandaloneModule()

Returns true if this web service belongs to a stand alone module. Corresponds to the IS_STAND_ALONE_MODULE_KEY key.

Returns:

true, if this web service belongs to a stand alone module

getBundleName

String getBundleName()

Returns the module name within a EAR or null if it is a stand alone module. Corresponds to the BUNDLE_NAME_KEY key.

Returns:

the bundle name

getServiceImplType

String getServiceImplType()

Returns the implementation type of this web service. Corresponds to the SERVICE_IMPL_TYPE_KEY key.

Returns:

either @see #EJB_IMPL or @ see #SERVLET_IMPL

getServiceImplName

String getServiceImplName()

Returns the implementation Ejb or Servlet name of this web service. Corresponds to the SERVICE_IMPL_NAME_KEY key.

Returns:

the Ejb or Servlet name

getServiceImplClass

String getServiceImplClass()

Returns the implementation Ejb or Servlet class name of this web service. Corresponds to the SERVICE_IMPL_CLASS_KEY key.

Returns:

the Ejb or Servlet class name

getWSDLFile

String getWSDLFile()

Returns the WSDL file Corresponds to the WSDL_FILE_KEY key.

Returns:

the WSDL file

getWebservicesFile

String getWebservicesFile()

Returns the webservices.xml file . Corresponds to the WEB_SERVICES_FILE_KEY key.

Returns:

the webservices file

getMappingFile

String getMappingFile()

Returns the mapping file. This is null for JAX-WS applications. Corresponds to the MAPPING_FILE_KEY key.

Returns:

the mapping file

getWebXML

String getWebXML()

Gets the web.xml file. This will be null for EJB web service endpoints. Corresponds to the WEB_XML_KEY key.

Returns:

webXML the web.xml file as String

getSunWebXML

String getSunWebXML()

Gets the sun-web.xml file. This will be null for EJB web service endpoints. Corresponds to the SUN_WEB_XML_KEY key.

Returns:

sunWebXML the sun-web.xml file

getEJBXML

String getEJBXML()

Gets the ejb.xml file. This will be null for Servlet web service endpoints. Corresponds to the EJB_XML_KEY key.

Returns:

EJBXML the ejb.xml file

getSunEJBXML

String getSunEJBXML()

Gets the sun-ejb.xml file. This will be null for Servlet web service endpoints. Corresponds to the SUN_EJB_XML_KEY key.

Returns:

sunEJBXML the sun-ejb.xml file

getApplicationXML

String getApplicationXML()

Gets the application.xml file. This will be null for web service in a standalone module. Corresponds to the APPLICATION_XML_KEY key.

Returns:

applicationXML the application.xml file

getDescriptors

String[] getDescriptors()

Returns the descriptor . The descriptors includes:

   WSDL, 
   webservices.xml, 
   mapping file 
 

in the above specified order. If the alt WSDL location is specified in the archive, the overridden (correct) WSDL file is returned.

Returns:

the descriptor

isSecure

boolean isSecure()

Returns true if this web service is secured or not. Corresponds to the IS_SECURE_KEY key.

Returns:

true, if this web service is secured, false otherwise