wsinclude in the
* namespace "http://apache.org/cocoon/wsinclude/1.0".
* The service elements contains the url which points to
* a Web Service, the response of which will replace the wsinclude element.
* The content of the wsinclude element is posted to the web service.
* N.B. The XML is written directly to the Web Service InputStream and is not wrapped
* in any request parameters. * All config parameters for wsinclude can be passed as either sitemap parameters OR * child elements of the wsinclude element.
* Sitemap Example: *
* <map:transform type="wsinclude" >
* <!-- If server is specified then service is relative to the server,
* and the URI to the Web Service is contrcuted using both server and service.
* If server is not specified then service must be a full URI to the Web Service -->
* <map:parameter name="server" value="http://some.web.service/"/ >
* <map:parameter name="service" value="/myservice"/ >
* <map:parameter name="timeout" value="20000"/ >
* <!-- Optional defaults to errors -->
* <map:parameter name="errors" value="wsincludeMessages"/ >
* <!-- Optional, defaults to no wrapper element-->
* <map:parameter name="response" value="wsincludeResponse"/ >
* <!-- Optional defaults to false -->
* <map:parameter name="relogin" value="true"/ >
* <!-- If relogin is true and the service returns the message indicated by
* this parameter, then an attempt is made to relogin to the service, and
* perform the original request again
* Defaults to: <message>Not logged in</message>
* -->
* <map:parameter name="notLoggedIn" value="<message>Not logged in</message>" />
* <!-- Optional defaults to current application -->
* <map:parameter name="application" value="boris"/ >
* <!-- Optional defaults to 0, number of times to retry on fatal error -->
* <map:parameter name="retries" value="1"/ >
* <!-- SOAP specific, if present a SOAP call to the method is performed
* instead if a HTTP POST, the entire XML withing the wsinclude is sent as a
* single Sting parameter to the method-->
* <map:parameter name="soapMethod" value="login"/ >
* </map:transform>
*
* In the XML :
* * <?xml version="1.0" encoding="UTF-8"? > * <data> * <ws:wsinclude xmlns:ws="http://apache.org/cocoon/wsinclude/1.0" > * <Config_Request> * <Action ActionType="login"> * <ActionParams> * <ActionParam ParamName="name">tonyc</ActionParam> * <ActionParam ParamName="password">cabbage</ActionParam> * <ActionParam ParamName="product">TTOOLS</ActionParam> * <ActionParam ParamName="domain"/> * </ActionParams> * </Action> * </Config_Request> * </ws:wsinclude> * </data> ** The relogin parameter indicates that if a
<message>Not logged in</message> response is
* received from the service, an attempt will be made to check the authentication
* framework for the appropriate load resource uri for the CURRENT application and if found
* call this uri. If you wish to cause a login of a different application then you must
* supply an 'application' parameter with the name of the application, as defined in the
* applications section of the top level sitemap
*
* @author Stephen Burns
*/
public class WSIncludeTransformer extends AbstractSAXTransformer implements MessageConstants{
//Constants
/** Default error element name */
public static final String DEFAULT_ERROR_ELEMENT="errors";
/** Default tiemout */
public static final int DEFAULT_TIMEOUT=10000;
/** Default retries */
public static final int DEFAULT_RETRIES=0;
/** Default response element name */
public static final String DEFAULT_RESPONSE_ELEMENT="response";
/** Defines a default generic response that will be understood to mean the user has been logged out */
public static String DEFAULT_NOT_LOGGED_IN_RESPONSE="<message>Not logged in</message>
* but can be modified by either setting a sitemap parameter to the wsinclude
* transform or within an element in the XML
*/
public static final String WSINCLUDE_NOT_LOGGED_IN_ELEMENT="notLoggedIn";
//instance variables
/** The current state: STATE_ */
protected int state;
/** The current external web service */
protected String server=null;
protected String relService=null;
/** Optional soapMethod */
protected String soapMethod=null;
/** Current timeout value allowed for web service, defaults to 10 seconds */
protected int timeout=DEFAULT_TIMEOUT;
/** Optional element, stored the name of a wrapper response element tag */
protected String wsResponseElement=null;
/** Contains the name of the errors tag, defaults to errors, e.g. messages */
protected String wsErrorElement=DEFAULT_ERROR_ELEMENT;
/** Stores any messages that need to be returned to the caller */
protected ArrayList messages=new ArrayList();
/** Optional cache id */
protected String cacheId=null;
/** Optional relogin */
protected boolean relogin=false;
/** Optional reset HttpClientWrapper session info */
protected boolean reset=false;
/** Optional retries */
protected int retries=DEFAULT_RETRIES;
/** Optional handler, used in conjunction with relogin*/
protected String handler=null;
/** Optional application, used in conjunction with relogin*/
protected String application=null;
/** Records the time the web service is called */
protected java.util.Date startTime;
/** Records the time the web service returns */
protected java.util.Date endTime;
/** Not logged in error message */
protected String notLoggedInMsg=DEFAULT_NOT_LOGGED_IN_RESPONSE;
/**
* Constructor
* Set the namespace for any tags that this transformer will recognise
*/
public WSIncludeTransformer() {
this.namespaceURI = WSINCLUDE_NAMESPACE_URI;
}
/**
* Setup the component.
*/
public void setup(SourceResolver resolver, Map objectModel,
String source, Parameters parameters)
throws ProcessingException, SAXException, IOException
{
super.setup(resolver, objectModel, source, parameters);
this.state = STATE_OUTSIDE;
//parameters can be specified as parameter elements within the
//transform element, (in the pipeline section of the sitemap)
//or as elements within the wsinclude element
// Web Service
this.relService = parameters.getParameter( WSINCLUDE_SERVICE_ELEMENT,null );
this.server = parameters.getParameter( WSINCLUDE_SERVER_ELEMENT,null );
//timeout
this.timeout = parameters.getParameterAsInteger(WSINCLUDE_TIMEOUT_ELEMENT,DEFAULT_TIMEOUT);
//Response element
this.wsResponseElement=parameters.getParameter( WSINCLUDE_RESPONSE_ELEMENT, null);
//Error element
this.wsErrorElement=parameters.getParameter( WSINCLUDE_ERROR_ELEMENT, DEFAULT_ERROR_ELEMENT);
//cacheid
this.cacheId=parameters.getParameter( WSINCLUDE_CACHEID_ELEMENT, null);
//relogin
this.relogin=parameters.getParameterAsBoolean( WSINCLUDE_RELOGIN_ELEMENT, false);
//reset
this.reset=parameters.getParameterAsBoolean( WSINCLUDE_RESET_ELEMENT, false);
//application
this.application=parameters.getParameter( WSINCLUDE_APPLICATION_ELEMENT, null);
//handler
this.handler=parameters.getParameter( WSINCLUDE_HANDLER_ELEMENT, null);
//Optional retries
this.retries=parameters.getParameterAsInteger( WSINCLUDE_RETRIES_ELEMENT, DEFAULT_RETRIES);
//Optional SOAP method
this.soapMethod=parameters.getParameter( WSINCLUDE_SOAP_ELEMENT, null);
//Optional
this.notLoggedInMsg=decode(parameters.getParameter( WSINCLUDE_NOT_LOGGED_IN_ELEMENT, DEFAULT_NOT_LOGGED_IN_RESPONSE));
}
/**
* Recycle the component
*/
public void recycle() {
super.recycle();
this.server=null;
this.relService=null;
this.timeout=DEFAULT_TIMEOUT;
this.endTime=null;
this.wsResponseElement=null;
this.startTime=null;
this.cacheId=null;
this.messages=new ArrayList();
this.wsErrorElement=DEFAULT_ERROR_ELEMENT;
this.soapMethod=null;
this.relogin=false;
this.reset=false;
this.handler=null;
this.application=null;
this.retries=DEFAULT_RETRIES;
this.notLoggedInMsg=DEFAULT_NOT_LOGGED_IN_RESPONSE;
}
/**
* Check for all tags and start recording if found
*/
public void startTransformingElement(String uri, String name, String raw, Attributes attr)
throws ProcessingException ,IOException, SAXException
{
if (name.equalsIgnoreCase( WSINCLUDE_INCLUDE_ELEMENT ) || name.equalsIgnoreCase( "include")) {
this.state = STATE_INSIDE; //inside the main tag
this.startSerializedXMLRecording(XMLUtils.defaultSerializeToXMLFormat(true));
}
//service (relative or absolute)
else if (name.equalsIgnoreCase(WSINCLUDE_SERVICE_ELEMENT) && this.state == STATE_INSIDE) {
this.startTextRecording();
}
//server
else if (name.equalsIgnoreCase(WSINCLUDE_SERVER_ELEMENT) && this.state == STATE_INSIDE) {
this.startTextRecording();
}
//timeout
else if (name.equalsIgnoreCase(WSINCLUDE_TIMEOUT_ELEMENT) && this.state == STATE_INSIDE) {
this.startTextRecording();
}
//error
else if (name.equalsIgnoreCase(WSINCLUDE_ERROR_ELEMENT) && this.state == STATE_INSIDE) {
this.startTextRecording();
}
//optional cache id element
else if (name.equalsIgnoreCase(WSINCLUDE_CACHEID_ELEMENT) && this.state == STATE_INSIDE) {
this.startTextRecording();
}
//optional relogin element
else if (name.equalsIgnoreCase(WSINCLUDE_RELOGIN_ELEMENT) && this.state == STATE_INSIDE) {
this.startTextRecording();
}
//optional reset element
else if (name.equalsIgnoreCase(WSINCLUDE_RESET_ELEMENT) && this.state == STATE_INSIDE) {
this.startTextRecording();
}
//optional response element
else if (name.equalsIgnoreCase(WSINCLUDE_RESPONSE_ELEMENT) && this.state == STATE_INSIDE) {
this.startTextRecording();
}
//optional soap method name element
else if (name.equalsIgnoreCase(WSINCLUDE_SOAP_ELEMENT) && this.state == STATE_INSIDE) {
this.startTextRecording();
}
//optional retries element
else if (name.equalsIgnoreCase(WSINCLUDE_RETRIES_ELEMENT) && this.state == STATE_INSIDE) {
this.startTextRecording();
}
//optional notLoggedIn element
else if (name.equalsIgnoreCase(WSINCLUDE_NOT_LOGGED_IN_ELEMENT) && this.state == STATE_INSIDE) {
this.startTextRecording();
}
//application, used in conjunction with relogin
else if (name.equalsIgnoreCase(WSINCLUDE_APPLICATION_ELEMENT) && this.state == STATE_INSIDE) {
this.startTextRecording();
}
//handler, used in conjunction with relogin
else if (name.equalsIgnoreCase(WSINCLUDE_HANDLER_ELEMENT) && this.state == STATE_INSIDE) {
this.startTextRecording();
}
//not for us
else {
super.startTransformingElement(uri, name, raw, attr);
}
}//startTransformingElement
/**
* On closing wsinclude tag the web service is invoked.
* The response from the web service replaces the original wsinclude element
*/
public void endTransformingElement(String uri, String name, String raw)
throws ProcessingException, IOException, SAXException
{
if (this.state == STATE_INSIDE){
if( name.equalsIgnoreCase( WSINCLUDE_INCLUDE_ELEMENT ) || name.equalsIgnoreCase( "include" ))
{
this.state = STATE_OUTSIDE;
startTime=new java.util.Date();
String wsRequest=endSerializedXMLRecording();
String wsResponse=callService(wsRequest);
//if logged out message in response try relogin
if (relogin && wsResponse!=null && wsResponse.indexOf(notLoggedInMsg)!=-1){
if (login()){
//Throw away previous response, and use this one
wsResponse=callService(wsRequest);
}
}
endTime=new java.util.Date();
//include web service response
includeResponse(wsResponse);
}
//Service (relative or absolute)
else if( name.equalsIgnoreCase( WSINCLUDE_SERVICE_ELEMENT ) ){
relService=this.endTextRecording();
}
//Server
else if( name.equalsIgnoreCase( WSINCLUDE_SERVER_ELEMENT ) ){
server=this.endTextRecording();
}
//timeout
else if( name.equalsIgnoreCase( WSINCLUDE_TIMEOUT_ELEMENT ) ){
try{
timeout=Integer.parseInt(this.endTextRecording());
}catch (NumberFormatException nfe){
}
if (this.getLogger().isDebugEnabled()) {
getLogger().debug("WSIncludeTransformer Service timeout set to " + timeout );
}
}
//Optional retries
else if( name.equalsIgnoreCase( WSINCLUDE_RETRIES_ELEMENT ) ){
try{
retries=Integer.parseInt(this.endTextRecording());
}catch (NumberFormatException nfe){
}
if (this.getLogger().isDebugEnabled()) {
getLogger().debug("WSIncludeTransformer Service retries set to " + retries );
}
}
//Optional notLoggedInMsg
else if( name.equalsIgnoreCase( WSINCLUDE_NOT_LOGGED_IN_ELEMENT ) ){
notLoggedInMsg=decode(this.endTextRecording());
if (this.getLogger().isDebugEnabled()) {
getLogger().debug("WSIncludeTransformer notLoggedInMsg set to " + notLoggedInMsg );
}
}
//error
else if (name.equalsIgnoreCase(WSINCLUDE_ERROR_ELEMENT)) {
wsErrorElement=this.endTextRecording();
if (this.getLogger().isDebugEnabled()) {
getLogger().debug("WSIncludeTransformer errors element set to " + wsErrorElement );
}
}
//optional response element
else if (name.equalsIgnoreCase(WSINCLUDE_RESPONSE_ELEMENT)) {
wsResponseElement=this.endTextRecording();
if (this.getLogger().isDebugEnabled()) {
getLogger().debug("WSIncludeTransformer response element set to " + wsResponseElement );
}
}
//optional cache id
else if (name.equalsIgnoreCase(WSINCLUDE_CACHEID_ELEMENT) ) {
cacheId=this.endTextRecording();
if (this.getLogger().isDebugEnabled()) {
getLogger().debug("WSIncludeTransformer cacheId set to " + cacheId);
}
}
//optional relogin
else if (name.equalsIgnoreCase(WSINCLUDE_RELOGIN_ELEMENT)) {
String reloginStr=this.endTextRecording();
if (reloginStr.trim().equalsIgnoreCase("true")){
relogin=true;
}
}
//optional soap method
else if (name.equalsIgnoreCase(WSINCLUDE_SOAP_ELEMENT) ) {
soapMethod=this.endTextRecording();
if (this.getLogger().isDebugEnabled()) {
getLogger().debug("WSIncludeTransformer soapMethod set to " + soapMethod );
}
}
//application
else if (name.equalsIgnoreCase(WSINCLUDE_APPLICATION_ELEMENT) ) {
application=this.endTextRecording();
}
//handelr
else if (name.equalsIgnoreCase(WSINCLUDE_HANDLER_ELEMENT) ) {
handler=this.endTextRecording();
}
}//end if inside
//not for us
else{
super.endTransformingElement(uri, name, raw);
}
}//end endTransformingElement
/**
* Calls the relevant WebService and perform required retry attempts
* if fatal error has occurred
*/
protected String callService(String wsRequest){
String wsResponse=null;
int attempt=1;
while (wsResponse==null && attempt<=(retries+1)) {
if (getLogger().isDebugEnabled())
getLogger().debug("WSInclude Attempt="+attempt);
URI serviceURI=createServiceURI(server,relService);
if (soapMethod!=null){
wsResponse=soapCall(serviceURI, soapMethod, wsRequest, timeout, cacheId);
}else {
wsResponse=httpPostToWebService(serviceURI, wsRequest, timeout, cacheId, reset);
}
attempt++;
}
if (wsResponse == null) {
wsResponse = "