Top Description Inners Methods
javax.jws

public @Interface WebParam

extends Annotation
Annotations
@Retention:RUNTIME
@Target:PARAMETER
Imports
java.lang.annotation.Retention, .RetentionPolicy, .Target, .ElementType
Customizes the mapping of an individual parameter to a Web Service message part and XML element.
Author
Copyright (c) 2004 by BEA Systems, Inc. All Rights Reserved.
Since
1.6

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
WebParam.Mode

The direction in which the parameter flows

Method Summary

Modifier and TypeMethod and Description
public boolean
header()

If true, the parameter is pulled from a message header rather then the message body.

public WebParam.Mode
mode()

The direction in which the parameter is flowing (One of IN, OUT, or INOUT).

public String
name()

Name of the parameter.

public String
partName()

The name of the wsdl:part representing this parameter.

public String
targetNamespace()

The XML namespace for the parameter.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

headerback to summary
public boolean header()

If true, the parameter is pulled from a message header rather then the message body.

modeback to summary
public WebParam.Mode mode()

The direction in which the parameter is flowing (One of IN, OUT, or INOUT).

The OUT and INOUT modes may only be specified for parameter types that conform to the definition of Holder types (JAX-WS 2.0 [5], section 2.3.3). Parameters that are Holder Types MUST be OUT or INOUT.

nameback to summary
public String name()

Name of the parameter.

If the operation is rpc style and @WebParam.partName has not been specified, this is name of the wsdl:part representing the parameter.
If the operation is document style or the parameter maps to a header, this is the local name of the XML element representing the parameter.

A name MUST be specified if the operation is document style, the parameter style is BARE, and the mode is OUT or INOUT.

partNameback to summary
public String partName()

The name of the wsdl:part representing this parameter.

This is only used if the operation is rpc style or if the operation is document style and the parameter style is BARE.

Since
2.0
targetNamespaceback to summary
public String targetNamespace()

The XML namespace for the parameter.

Only used if the operation is document style or the paramater maps to a header. If the target namespace is set to "", this represents the empty namespace.

javax.jws back to summary

public final Enum WebParam.Mode

extends Enum<WebParam.Mode>
Class Inheritance
The direction in which the parameter flows

Field Summary

Modifier and TypeField and Description
public static final WebParam.Mode
IN

public static final WebParam.Mode
INOUT

public static final WebParam.Mode
OUT

Constructor Summary

AccessConstructor and Description
private
Mode()

Method Summary

Modifier and TypeMethod and Description
public static WebParam.Mode
valueOf(String name)

public static WebParam.Mode[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

INback to summary
public static final WebParam.Mode IN
INOUTback to summary
public static final WebParam.Mode INOUT
OUTback to summary
public static final WebParam.Mode OUT

Constructor Detail

Modeback to summary
private Mode()

Method Detail

valueOfback to summary
public static WebParam.Mode valueOf(String name)
valuesback to summary
public static WebParam.Mode[] values()