Operation (JDPWS 0.11.2-SNAPSHOT API)

java.lang.Object
- org.ws4d.java.types.AttributableSupport
- - org.ws4d.java.service.OperationCommons
  - - org.ws4d.java.service.Operation

All Implemented Interfaces:

OperationDescription, Attributable

Direct Known Subclasses:

OperationStub
```
public abstract class Operation
extends OperationCommons
```
An operation is an abstraction of executable code. Operations are (together with events) the main parts of a service implementation.

The actual business logic behind an operation is contained within the invoke(ParameterValue) method. Operation subclasses are required to overwrite it providing the code to be executed when this operation is called.

Before adding an operation to a service, the types of its input and output parameters must be defined in terms of XML Schema constructs like elements, simple types and complex typess. A simple operation with no input and a single string message as its only output parameter could look like:
```
 Operation myOperation = new Operation() {

     public ParameterValue invoke(ParameterValue params)
         throws InvocationException, TimeotException {
         // business logic goes here
         ...
     }

 };
 Element message = new Element("message",
     "http://www.example.org/messageService", SchemaUtil.TYPE_STRING);
 myOperation.setOutput(message);
 
```
Additionally, if an operation's invocation can cause expected (checked) exceptional conditions (errors), they must be declared as faults. Note: According to WSDL 1.1 Specification, an operation's name is not required to be unique within the scope of its containing port type in order to support overloading. However, when overloading operations, the combination of each one's name, input name and output name must be unique in order to avoid name clashes.

Field Summary
- Fields inherited from class org.ws4d.java.service.OperationCommons
  inputAttributable, outputAttributable, type
- Fields inherited from class org.ws4d.java.types.AttributableSupport
  attributes

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Operation()` Creates a new operation instance without specified name.
	`Operation(java.lang.String name)` Creates a new operation instance with the given `name`.
	`Operation(java.lang.String name, QName portType)` Creates a new operation instance with the given local `name` and `portType`.
	`Operation(java.lang.String name, java.lang.String serviceName)` Creates a new operation instance with the given `name` and the name of the specified service.
`protected`	`Operation(WSDLOperation operation)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`getType()` Returns the `transmission type` of this operation according to WSDL 1.1 specification.
`ParameterValue`	`invoke(ParameterValue parameterValue)` Deprecated. use `invoke(ParameterValue, CredentialInfo)`.
`ParameterValue`	`invoke(ParameterValue parameterValue, CredentialInfo credentialInfo)` Method for invoke this Operation.
`protected abstract ParameterValue`	`invokeImpl(ParameterValue parameterValue, CredentialInfo credentialInfo)` This method must be overwritten from User.
`boolean`	`isOneWay()` Returns `true` if the transmission type of this operation is `WSDLOperation.TYPE_ONE_WAY`.
`boolean`	`isRequestResponse()` Returns `true` if the transmission type of this operation is `WSDLOperation.TYPE_REQUEST_RESPONSE`.

Methods inherited from class org.ws4d.java.service.OperationCommons
addCustomComplexType, addFault, addInputParameter, addOutputParameter, clearCustomComplexTypes, createFaultValue, createFaultValue, createInputValue, createInputValue, createOutputValue, createOutputValue, equals, getCustomComplexTypes, getFault, getFaultAttribute, getFaultAttributes, getFaultCount, getFaults, getInput, getInputAction, getInputAttribute, getInputAttributes, getInputName, getInputParameter, getName, getNameQuallified, getOutput, getOutputAction, getOutputAttribute, getOutputAttributes, getOutputName, getOutputParameter, getPortType, getService, hasFaultAttributes, hashCode, hasInputAttributes, hasOutputAttributes, isInputActionSet, isInputNameSet, isOutputActionSet, isOutputNameSet, removeCustomComplexType, removeFault, setFaultAttribute, setFaultAttributes, setInput, setInputAction, setInputAttribute, setInputAttributes, setInputName, setInputNameInternal, setOutput, setOutputAction, setOutputAttribute, setOutputAttributes, setOutputName, setOutputNameInternal, setService, toString

Methods inherited from class org.ws4d.java.types.AttributableSupport
getAttribute, getAttributes, hasAttributes, serializeAttributes, setAttribute, setAttribute, setAttributes

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Operation
```
public Operation(java.lang.String name,
                 QName portType)
```
    Creates a new operation instance with the given local name and portType.
    
    Parameters:
    
    name - the name of the operation; see here for a short description of uniqueness requirements regarding operation names
    
    portType - the qualified port type of the operation
  - Operation
```
public Operation()
```
    Creates a new operation instance without specified name.
  - Operation
```
public Operation(java.lang.String name)
```
    Creates a new operation instance with the given name.
    
    Parameters:
    
    name -
  - Operation
```
public Operation(java.lang.String name,
                 java.lang.String serviceName)
```
    Creates a new operation instance with the given name and the name of the specified service. Namespace default is "http://www.ws4d.or" can be set once in the DefaultDevice (setDefaultNamespace). There is also the possibility to set the namespace for every operation.
    
    Parameters:
    
    name -
  - Operation
```
protected Operation(WSDLOperation operation)
```
- Method Detail
  - getType
```
public final int getType()
```
    Returns the transmission type of this operation according to WSDL 1.1 specification. The value returned is one of WSDLOperation.TYPE_ONE_WAY or WSDLOperation.TYPE_REQUEST_RESPONSE.
    
    Specified by:
    
    getType in interface OperationDescription
    
    Specified by:
    
    getType in class OperationCommons
    
    Returns:
    
    type the transmission type of this operation
  - isOneWay
```
public final boolean isOneWay()
```
    Returns true if the transmission type of this operation is WSDLOperation.TYPE_ONE_WAY. Returns false in any other case.
    
    Returns:
    
    checks whether this is a one-way operation
  - isRequestResponse
```
public final boolean isRequestResponse()
```
    Returns true if the transmission type of this operation is WSDLOperation.TYPE_REQUEST_RESPONSE. Returns false in any other case.
    
    Returns:
    
    checks whether this is a request-response operation
  - invoke
```
public final ParameterValue invoke(ParameterValue parameterValue)
                            throws InvocationException,
                                   CommunicationException
```
    Deprecated. use invoke(ParameterValue, CredentialInfo).
    
    Old Method for invoking operation. This method will always return null. Please use the new method for Invoke.
    
    Parameters:
    
    parameterValue -
    
    Returns:
    
    parameterValue
    
    Throws:
    
    InvocationException
    
    CommunicationException
  - invoke
```
public final ParameterValue invoke(ParameterValue parameterValue,
                                   CredentialInfo credentialInfo)
                            throws InvocationException,
                                   CommunicationException,
                                   AuthorizationException
```
    Method for invoke this Operation. Call with ParameterValue and CredentialInfo. If no security will be used, use CredentialInfo.EMPTY_CREDENTIAL_INFO instead of null.
    Parameters: parameterValue - for invoke. credentialInfo - if security is available. Returns: parameter value Throws: InvocationException CommunicationException AuthorizationException
  invokeImpl protected abstract ParameterValue invokeImpl(ParameterValue parameterValue, CredentialInfo credentialInfo) throws InvocationException, CommunicationException This method must be overwritten from User. This method will inherit the relevant code for invoking the operation. Parameters: parameterValue - credentialInfo - Returns: ParameterValue Throws: InvocationException CommunicationException

Class Operation

Field Summary

Fields inherited from class org.ws4d.java.service.OperationCommons

Fields inherited from class org.ws4d.java.types.AttributableSupport

Constructor Summary

Method Summary

Methods inherited from class org.ws4d.java.service.OperationCommons

Methods inherited from class org.ws4d.java.types.AttributableSupport

Methods inherited from class java.lang.Object

Constructor Detail

Operation

Operation

Operation

Operation

Operation

Method Detail

getType

isOneWay

isRequestResponse

invoke

invoke

invokeImpl