Top Description Fields Constructors Methods
org.apache.tomcat.util.descriptor.web

public Class ContextService

extends ResourceBase
Class Inheritance
Imports
java.util.Arrays, .HashMap, .Iterator, .Map

Representation of a web service reference for a web application, as represented in a <service-ref> element in the deployment descriptor.
Author
Fabien Carrion

Field Summary

Modifier and TypeField and Description
private String
displayname

The WebService reference name.

private final Map<String, ContextHandler>
handlers

A list of Handlers to use for this service-ref.

private String
jaxrpcmappingfile

A file specifying the correlation of the WSDL definition to the interfaces (Service Endpoint Interface, Service Interface).

private String
largeIcon

A large icon for this WebService.

private static final long
private String
serviceInterface

The fully qualified class name of the JAX-WS Service interface that the client depends on.

private String[]
serviceqname

Declares the specific WSDL service element that is being referred to.

private String
smallIcon

A small icon for this WebService.

private String
wsdlfile

Contains the location (relative to the root of the module) of the web service WSDL description.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
public void
addPortcomponent(String serviceendpoint, String portlink)

public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides org.apache.tomcat.util.descriptor.web.ResourceBase.equals.

Indicates whether some other object is "equal to" this one.

public String
public ContextHandler
getHandler(String handlername)

public Iterator<String>
public String
public String
public String
public Iterator<String>

Returns:

the endpoint names
getServiceendpoints
()

Declares a client dependency on the container to resolving a Service Endpoint Interface to a WSDL port.

public String[]
public String
public String
public String
public String
public String
public int
hashCode()

Overrides org.apache.tomcat.util.descriptor.web.ResourceBase.hashCode.

Returns a hash code value for this object.

public void
setDisplayname(String displayname)

public void
setInterface(String serviceInterface)

public void
setJaxrpcmappingfile(String jaxrpcmappingfile)

public void
setLargeIcon(String largeIcon)

public void
setServiceqname(String[] serviceqname)

public void
setServiceqname(String serviceqname, int i)

public void
public void
public void
setSmallIcon(String smallIcon)

public void
setWsdlfile(String wsdlfile)

public String
toString()

Overrides java.lang.Object.toString.

Return a String representation of this object.

Inherited from org.apache.tomcat.util.descriptor.web.ResourceBase:
addInjectionTargetgetDescriptiongetInjectionTargetsgetLookupNamegetNamegetNamingResourcesgetPropertygetTypelistPropertiesremovePropertysetDescriptionsetLookupNamesetNamesetNamingResourcessetPropertysetType

Field Detail

displaynameback to summary
private String displayname

The WebService reference name.

handlersback to summary
private final Map<String, ContextHandler> handlers

A list of Handlers to use for this service-ref. The instantiation of the handler have to be done.

jaxrpcmappingfileback to summary
private String jaxrpcmappingfile

A file specifying the correlation of the WSDL definition to the interfaces (Service Endpoint Interface, Service Interface).

largeIconback to summary
private String largeIcon

A large icon for this WebService.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.apache.tomcat.util.descriptor.web.ResourceBase.serialVersionUID.

serviceInterfaceback to summary
private String serviceInterface

The fully qualified class name of the JAX-WS Service interface that the client depends on.

serviceqnameback to summary
private String[] serviceqname

Declares the specific WSDL service element that is being referred to. It is not specified if no wsdl-file is declared or if WSDL contains only 1 service element. A service-qname is composed by a namespaceURI and a localpart. It must be defined if more than 1 service is declared in the WSDL. serviceqname[0] : namespaceURI serviceqname[1] : localpart

smallIconback to summary
private String smallIcon

A small icon for this WebService.

wsdlfileback to summary
private String wsdlfile

Contains the location (relative to the root of the module) of the web service WSDL description.

Constructor Detail

ContextServiceback to summary
public ContextService()

Method Detail

addHandlerback to summary
public void addHandler(ContextHandler handler)
addPortcomponentback to summary
public void addPortcomponent(String serviceendpoint, String portlink)
equalsback to summary
public boolean equals(Object obj)

Overrides org.apache.tomcat.util.descriptor.web.ResourceBase.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getDisplaynameback to summary
public String getDisplayname()
getHandlerback to summary
public ContextHandler getHandler(String handlername)
getHandlersback to summary
public Iterator<String> getHandlers()
getInterfaceback to summary
public String getInterface()
getJaxrpcmappingfileback to summary
public String getJaxrpcmappingfile()
getLargeIconback to summary
public String getLargeIcon()
getServiceendpointsback to summary
public Iterator<String> getServiceendpoints()

Declares a client dependency on the container to resolving a Service Endpoint Interface to a WSDL port. It optionally associates the Service Endpoint Interface with a particular port-component.

Returns:Iterator<String>

the endpoint names

getServiceqnameback to summary
public String[] getServiceqname()
getServiceqnameback to summary
public String getServiceqname(int i)
getServiceqnameLocalpartback to summary
public String getServiceqnameLocalpart()
getServiceqnameNamespaceURIback to summary
public String getServiceqnameNamespaceURI()
getSmallIconback to summary
public String getSmallIcon()
getWsdlfileback to summary
public String getWsdlfile()
hashCodeback to summary
public int hashCode()

Overrides org.apache.tomcat.util.descriptor.web.ResourceBase.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
setDisplaynameback to summary
public void setDisplayname(String displayname)
setInterfaceback to summary
public void setInterface(String serviceInterface)
setJaxrpcmappingfileback to summary
public void setJaxrpcmappingfile(String jaxrpcmappingfile)
setLargeIconback to summary
public void setLargeIcon(String largeIcon)
setServiceqnameback to summary
public void setServiceqname(String[] serviceqname)
setServiceqnameback to summary
public void setServiceqname(String serviceqname, int i)
setServiceqnameLocalpartback to summary
public void setServiceqnameLocalpart(String localpart)
setServiceqnameNamespaceURIback to summary
public void setServiceqnameNamespaceURI(String namespaceuri)
setSmallIconback to summary
public void setSmallIcon(String smallIcon)
setWsdlfileback to summary
public void setWsdlfile(String wsdlfile)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Return a String representation of this object.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations
@Override