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

WebServiceEndpointInfo

public interface WebServiceEndpointInfo implements com.sun.appserv.management.base.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

Fields Summary
public static final String
APP_ID_KEY
Application ID
public static final String
NAME_KEY
Name of the web service
public static final String
END_POINT_URI_KEY
Relative end point URI
public static final String
IS_STAND_ALONE_MODULE_KEY
Decides if this web service end point is in a stand alone Module or not.
public static final String
BUNDLE_NAME_KEY
Bundle (embedded module) name, if applicable
public static final String
SERVICE_IMPL_NAME_KEY
EJB or Servlet name
public static final String
SERVICE_IMPL_CLASS_KEY
EJB or Servlet class name
public static final String
SERVICE_IMPL_TYPE_KEY
Web service implementation type - @see #EJB_IMPL or @see #SERVLET_IMPL
public static final String
WSDL_FILE_KEY
WSDL file
public static final String
WEB_SERVICES_FILE_KEY
webservices.xml file
public static final String
WSDL_FILE_LOCATION_KEY
WSDL location file
public static final String
MAPPING_FILE_KEY
Mapping file
public static final String
MAPPING_FILE_LOCATION_KEY
Mapping file location
public static final String
APPLICATION_XML_KEY
application.xml file
public static final String
WEB_XML_KEY
web.xml file
public static final String
EJB_XML_KEY
ejb.xml file
public static final String
SUN_WEB_XML_KEY
sun-web.xml file
public static final String
SUN_EJB_XML_KEY
ejb.xml file
public static final String
EJB_IMPL
EJB implementation type name
public static final String
SERVLET_IMPL
Servlet implementation type name
public static final String
CLASS_NAME
This interface's class name
public static final String
THROUGHPUT_STATISTIC
Throuput statistic's name
public static final String
SERVICE_URL_KEY
Service URL's name
public static final String
IS_SECURE_KEY
Decides if this web service end point is secured or not.
Constructors Summary
Methods Summary
public java.lang.StringgetAppID()
Returns the name of the application or stand alone module that has this web service. Corresponds to the {@link #APP_ID_KEY} key.

return
the Application Id

public java.lang.StringgetApplicationXML()
Gets the application.xml file. This will be null for web service in a standalone module. Corresponds to the {@link #APPLICATION_XML_KEY} key.

return
applicationXML the application.xml file

public java.lang.StringgetBundleName()
Returns the module name within a EAR or null if it is a stand alone module. Corresponds to the {@link #BUNDLE_NAME_KEY} key.

return
the bundle name

public java.lang.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.

return
the descriptor

public java.lang.StringgetEJBXML()
Gets the ejb.xml file. This will be null for Servlet web service endpoints. Corresponds to the {@link #EJB_XML_KEY} key.

return
EJBXML the ejb.xml file

public java.lang.StringgetEndpointURI()
Returns the relative URI of this endpoint. Corresponds to the {@link #END_POINT_URI_KEY} key.

return
the uri string

public java.lang.StringgetMappingFile()
Returns the mapping file. This is null for JAX-WS applications. Corresponds to the {@link #MAPPING_FILE_KEY} key.

return
the mapping file

public java.lang.StringgetName()
Returns the name of the WebService. Corresponds to the {@link #NAME_KEY} key.

return
fully qualified name of this WebService

public java.lang.StringgetServiceImplClass()
Returns the implementation Ejb or Servlet class name of this web service. Corresponds to the {@link #SERVICE_IMPL_CLASS_KEY} key.

return
the Ejb or Servlet class name

public java.lang.StringgetServiceImplName()
Returns the implementation Ejb or Servlet name of this web service. Corresponds to the {@link #SERVICE_IMPL_NAME_KEY} key.

return
the Ejb or Servlet name

public java.lang.StringgetServiceImplType()
Returns the implementation type of this web service. Corresponds to the {@link #SERVICE_IMPL_TYPE_KEY} key.

return
either @see #EJB_IMPL or @ see #SERVLET_IMPL

public java.lang.StringgetServiceURL()
Gets the service URL of this web service endpoint. Corresponds to the {@link #SERVICE_URL_KEY} key.

return
service URL

public java.lang.StringgetSunEJBXML()
Gets the sun-ejb.xml file. This will be null for Servlet web service endpoints. Corresponds to the {@link #SUN_EJB_XML_KEY} key.

return
sunEJBXML the sun-ejb.xml file

public java.lang.StringgetSunWebXML()
Gets the sun-web.xml file. This will be null for EJB web service endpoints. Corresponds to the {@link #SUN_WEB_XML_KEY} key.

return
sunWebXML the sun-web.xml file

public java.lang.StringgetWSDLFile()
Returns the WSDL file Corresponds to the {@link #WSDL_FILE_KEY} key.

return
the WSDL file

public java.lang.StringgetWebXML()
Gets the web.xml file. This will be null for EJB web service endpoints. Corresponds to the {@link #WEB_XML_KEY} key.

return
webXML the web.xml file as String

public java.lang.StringgetWebservicesFile()
Returns the webservices.xml file . Corresponds to the {@link #WEB_SERVICES_FILE_KEY} key.

return
the webservices file

public booleanisAppStandaloneModule()
Returns true if this web service belongs to a stand alone module. Corresponds to the {@link #IS_STAND_ALONE_MODULE_KEY} key.

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

public booleanisSecure()
Returns true if this web service is secured or not. Corresponds to the {@link #IS_SECURE_KEY} key.

return
true, if this web service is secured, false otherwise