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

public Class ContextHandler

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

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

Field Summary

Modifier and TypeField and Description
private String
handlerclass

The Handler reference class.

private final List<String>
portNames

The portName.

private static final long
private final Map<String, String>
soapHeaders

A list of QName specifying the SOAP Headers the handler will work on.

private final List<String>
soapRoles

The soapRole.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
addPortName(String portName)

public void
addSoapHeaders(String localpart, String namespaceuri)

public void
addSoapRole(String soapRole)

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 Iterator<String>
public String
public String
getPortName(int i)

public int
public String
getSoapRole(int i)

public int
public int
hashCode()

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

Returns a hash code value for this object.

public void
setHandlerclass(String handlerclass)

public void
setProperty(String
The property name
name
,
String
The property value
value
)

Set a configured property.

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

handlerclassback to summary
private String handlerclass

The Handler reference class.

portNamesback to summary
private final List<String> portNames

The portName.

serialVersionUIDback to summary
private static final long serialVersionUID

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

soapHeadersback to summary
private final Map<String, String> soapHeaders

A list of QName specifying the SOAP Headers the handler will work on. -namespace and localpart values must be found inside the WSDL. A service-qname is composed by a namespaceURI and a localpart. soapHeader[0] : namespaceURI soapHeader[1] : localpart

soapRolesback to summary
private final List<String> soapRoles

The soapRole.

Constructor Detail

ContextHandlerback to summary
public ContextHandler()

Method Detail

addPortNameback to summary
public void addPortName(String portName)
addSoapHeadersback to summary
public void addSoapHeaders(String localpart, String namespaceuri)
addSoapRoleback to summary
public void addSoapRole(String soapRole)
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
getHandlerclassback to summary
public String getHandlerclass()
getLocalpartsback to summary
public Iterator<String> getLocalparts()
getNamespaceuriback to summary
public String getNamespaceuri(String localpart)
getPortNameback to summary
public String getPortName(int i)
getPortNamesSizeback to summary
public int getPortNamesSize()
getSoapRoleback to summary
public String getSoapRole(int i)
getSoapRolesSizeback to summary
public int getSoapRolesSize()
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
setHandlerclassback to summary
public void setHandlerclass(String handlerclass)
setPropertyback to summary
public void setProperty(String name, String value)

Set a configured property.

Parameters
name:String

The property name

value:String

The property value

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