public class OpenWebServiceComponentImpl extends AbstractManagedComponentImpl implements OpenWebServiceComponent
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer | DEVICE_FORMAT
The device format for web service requests.
|
static java.util.Vector | DEVICE_FORMAT_VECTOR
The vector representing the device format id for web service responses views.
|
static java.lang.String | KEY_SUCCESS
The response property key to indicate whether processing was successful or a failure.
|
static java.lang.String | REQUEST_DOCUMENT_PARAM
Constant representing the key used in the request parameters of the JSP that will have the original XML element of the request.
|
static java.lang.String | RESPONSE_ONLY_PARAM
Constant representing that the purpose of the service request is just to present information and no business logic needs to be executed.
|
static java.lang.String | WEBSERVICE_MESSAGE_MAPPER
The message mapper used by the web service implementation.
|
Constructor and Description |
---|
OpenWebServiceComponentImpl()
This is the default constructor for this class.
|
Modifier and Type | Method and Description |
---|---|
protected void | beginActivityServiceRequest(ActivityToken activityToken, ActivityData activityData)
This method begins a new transaction and starts the request for the activity by calling the parent implementation.
|
protected void | completeActivityToken(ActivityToken activityToken)
This method provides the opportunity to complete an activity after the service command has been executed.
|
protected ActivityToken | createActivityToken(javax.xml.soap.SOAPHeader soapHeader, java.util.Map requestParameters)
This method is called if an activity token has not been resolved already.
|
javax.xml.soap.SOAPElement | executeService(javax.xml.soap.SOAPElement soapElementRequest)
This method invokes the web service request by processing the SOAPElement request.
|
protected ActivityToken | findActivityToken(javax.xml.soap.SOAPHeader soapHeader, java.util.Map requestParameters)
This method finds the activity token from the SOAP header of this request.
|
javax.xml.soap.SOAPElement | getSOAPElementRequest()
This method returns the SOAP element associated with the web service request.
|
javax.xml.soap.SOAPElement | getSOAPElementResponse()
This method returns the response of the web service request in the form of a SOAP element.
|
javax.xml.soap.SOAPEnvelope | getSOAPEnvelope()
This method returns the SOAP envelope associated with the web service request.
|
protected void | invokeCompositionService(ActivityToken activityToken, java.lang.String viewTaskName, java.util.Map requestParameters, java.util.Map responseParameters)
This method invokes the composition service that creates the XML response resulting from the web service request.
|
static TypedProperty | mergeMaps(TypedProperty initialMap, TypedProperty additionalMap)
This method merges the source parameters with the initial parameters.
|
protected boolean | preprocess(ActivityToken activityToken, java.util.Map requestParameters, java.lang.String interfaceName)
This method determines whether the request is a data retrieval request.
|
protected void | preprocessRequestParameters(java.util.Map requestParameters)
This method updates the request before calling the execute service command method.
|
protected void | processErrorResponse(ActivityToken activityToken, java.util.Map requestParameters, ErrorDataBean errorDataBean)
This method prepares the response of the web service request by creating the necessary objects required by the composition service.
|
protected void | processResponse(ActivityToken activityToken, java.util.Map requestParameters, java.util.Map responseParameters)
This method processes the response when the service command has been successfully executed.
|
protected ActivityToken | resolveActivityToken(javax.xml.soap.SOAPHeader soapHeader, java.util.Map requestParameters)
This method resolves the activity token associated with the request.
|
protected CommandProperty | resolveCommandProperty(javax.xml.soap.SOAPElement soapElementRequest)
This method converts the request to a command property.
|
protected void | setCompleteActivity(boolean completeActivity)
This method sets whether the activity should be completed after the request has been executed and a response is generated.
|
void | setSOAPElementRequest(javax.xml.soap.SOAPElement soapElementRequest)
This method sets the SOAP element that represents the request of the web service.
|
void | setSOAPElementResponse(javax.xml.soap.SOAPElement soapElementResponse)
This method sets the SOAP element that represents the response of the web service.
|
public static final java.lang.Integer DEVICE_FORMAT
public static final java.util.Vector DEVICE_FORMAT_VECTOR
public static final java.lang.String WEBSERVICE_MESSAGE_MAPPER
public static final java.lang.String REQUEST_DOCUMENT_PARAM
public static final java.lang.String RESPONSE_ONLY_PARAM
public static final java.lang.String KEY_SUCCESS
public OpenWebServiceComponentImpl()
protected boolean preprocess(ActivityToken activityToken, java.util.Map requestParameters, java.lang.String interfaceName) throws ServiceException
protected void processResponse(ActivityToken activityToken, java.util.Map requestParameters, java.util.Map responseParameters) throws ServiceException
protected void processErrorResponse(ActivityToken activityToken, java.util.Map requestParameters, ErrorDataBean errorDataBean) throws ServiceException
protected void invokeCompositionService(ActivityToken activityToken, java.lang.String viewTaskName, java.util.Map requestParameters, java.util.Map responseParameters) throws ServiceException
public final javax.xml.soap.SOAPElement executeService(javax.xml.soap.SOAPElement soapElementRequest) throws ServiceException
protected CommandProperty resolveCommandProperty(javax.xml.soap.SOAPElement soapElementRequest)
protected final ActivityToken resolveActivityToken(javax.xml.soap.SOAPHeader soapHeader, java.util.Map requestParameters) throws ServiceException
protected ActivityToken findActivityToken(javax.xml.soap.SOAPHeader soapHeader, java.util.Map requestParameters) throws ServiceException
This method finds the activity token from the SOAP header of this request. This implementation parses the SOAP header and looks for a node that represents the activity token. If the node is found and the activity token is valid, then the activity token is resolved. If the activity token is not valid, a service exception will be thrown. If an activity token is not found then null is returned.
10001 sg399bs99gesgs
protected ActivityToken createActivityToken(javax.xml.soap.SOAPHeader soapHeader, java.util.Map requestParameters) throws ServiceException
This method is called if an activity token has not been resolved already. In this case the implementation will check the SOAP header to see if credentials can be found in the request. If credentials exist then a temporary activity will be created based on the found credentials. Credentials will either be in the form of a user id and password or a certificate. If no credentials are found then no activity is returned. If an activity is created, the activity will be marked to be completed at the end of servicing the request.
logonId password
protected final void completeActivityToken(ActivityToken activityToken) throws ServiceException
protected void preprocessRequestParameters(java.util.Map requestParameters)
public static TypedProperty mergeMaps(TypedProperty initialMap, TypedProperty additionalMap)
protected final void setCompleteActivity(boolean completeActivity)
public javax.xml.soap.SOAPElement getSOAPElementRequest()
public javax.xml.soap.SOAPElement getSOAPElementResponse()
public void setSOAPElementRequest(javax.xml.soap.SOAPElement soapElementRequest)
public void setSOAPElementResponse(javax.xml.soap.SOAPElement soapElementResponse)
public javax.xml.soap.SOAPEnvelope getSOAPEnvelope()
protected void beginActivityServiceRequest(ActivityToken activityToken, ActivityData activityData) throws ServiceException, ECSystemException