org.hpccsystems.ws.client.BaseHPCCWsClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of wsclient Show documentation
Show all versions of wsclient Show documentation
This project allows a user to interact with ESP services in a controlled manner. The API calls available under org.hpccsystems.ws.client.platform allow for a user to target ESP's across multiple environments running a range of hpccsystems-platform versions. There is no guarantee that if a user utilizes org.hpccsystems.ws.client.gen generated stub code from wsdl, that the calls will be backwards compatible with older hpccsystems-platform versions.
package org.hpccsystems.ws.client;
import java.net.MalformedURLException;
import java.net.URL;
import org.apache.axis2.AxisFault;
import org.apache.axis2.addressing.EndpointReference;
import org.apache.axis2.client.Options;
import org.apache.axis2.client.Stub;
import org.apache.axis2.transport.http.HTTPConstants;
import org.apache.axis2.transport.http.impl.httpclient4.HttpTransportPropertiesImpl;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.hpccsystems.ws.client.platform.Version;
import org.hpccsystems.ws.client.utils.Connection;
import org.hpccsystems.ws.client.utils.DataSingleton;
import org.hpccsystems.ws.client.utils.EqualsUtil;
import org.hpccsystems.ws.client.utils.HashCodeUtil;
import org.hpccsystems.ws.client.utils.Utils;
import org.hpccsystems.ws.client.wrappers.ArrayOfECLExceptionWrapper;
import org.hpccsystems.ws.client.wrappers.ArrayOfEspExceptionWrapper;
import org.hpccsystems.ws.client.wrappers.EspSoapFaultWrapper;
public abstract class BaseHPCCWsClient extends DataSingleton
{
protected static final Logger log = LogManager.getLogger(BaseHPCCWsClient.class);
public static final String DEAFULTECLWATCHPORT = "8010";
public static final String DEFAULTECLWATCHTLSPORT = "18010";
public static String DEFAULTSERVICEPORT = DEAFULTECLWATCHPORT;
protected Connection fsconn = null;
protected boolean verbose = false;
protected String initErrMessage = "";
protected Version targetVersion = null;
protected Stub stub;
/**
* Gets the default stub.
*
* @return the default stub
* @throws AxisFault
* the axis fault
*/
abstract public Stub getDefaultStub() throws AxisFault;
/**
* Gets the service version.
*
* @param client
* the client
* @return the service version
*/
public static String getServiceVersion(BaseHPCCWsClient client)
{
String ver = null;
if (client != null)
{
Stub stub;
try
{
stub = client.getDefaultStub();
ver = getServiceVersion(stub);
}
catch (AxisFault e)
{
e.printStackTrace();
}
}
return ver;
}
/**
* Gets the service version.
*
* @param stub
* the stub
* @return the service version
*/
public static String getServiceVersion(Stub stub)
{
String ver = null;
if (stub != null)
{
String address = getServiceWSDLURL(stub);
if (address != null && !address.isEmpty())
{
ver = Utils.parseVersionFromWSDLURL(address);
}
}
return ver;
}
/**
* Gets the service WSDLURL.
*
* @param stub
* the stub
* @return the service WSDLURL
*/
public static String getServiceWSDLURL(Stub stub)
{
String address = null;
if (stub != null)
{
Options options = stub._getServiceClient().getOptions();
if (options != null)
{
address = options.getTo().getAddress();
}
}
return address;
}
/**
* Gets the service WSDL port.
*
* @param stub
* the stub
* @return the service WSDL port
* @throws MalformedURLException
* the malformed URL exception
*/
public static int getServiceWSDLPort(Stub stub) throws MalformedURLException
{
int port = -1;
if (stub != null)
{
String address = getServiceWSDLURL(stub);
if (address != null && !address.isEmpty())
{
port = (new URL(address)).getPort();
}
}
return port;
}
/**
* Gets the connection URL.
*
* @return the connection URL
* @throws Exception
* the exception
*/
public URL getConnectionURL() throws Exception
{
URL address = null;
verifyStub();
Options opt = stub._getServiceClient().getOptions();
EndpointReference toAddress = opt.getTo();
if (toAddress != null) address = new URL(toAddress.getAddress());
return address;
}
/**
* Sets the verbose.
*
* @param verbose
* - sets verbose mode
*/
public void setVerbose(boolean verbose)
{
this.verbose = verbose;
}
/**
* Gets the verbose.
*
* @return the verbose
*/
public boolean getVerbose()
{
return this.verbose;
}
/**
* Should be called after instantiation to confirm
* Successful initialization.
*
* The client init can fail due to many different types of issues
* including invalid connectivity options, invalid credentials, etc
*
* @return true, if successful
*/
public boolean hasInitError()
{
return !initErrMessage.isEmpty();
}
/**
* Returns error message encountered during initialization of wsdfuclient.
* Empty string if no error encountered
*
* @return the inits the error
*/
public String getInitError()
{
return initErrMessage;
}
/**
* Provides Stub object if available, otherwise throws
* Object can be used to access the web service methods directly.
*
* @return the stub
* @throws Exception
* the exception
*/
protected Stub verifyStub() throws Exception
{
if (stub != null)
return stub;
else
throw new Exception("WS Client Stub not available.");
}
/*
* (non-Javadoc)
*
* @see org.hpccsystems.ws.client.utils.DataSingleton#equals(java.lang.Object)
*/
@Override
public boolean equals(Object aThat)
{
if (this == aThat) return true;
if (!(aThat instanceof BaseHPCCWsClient)) return false;
if (!(aThat.getClass().isInstance(this))) return false;
BaseHPCCWsClient that = (BaseHPCCWsClient) aThat;
Options thatopt;
try
{
Stub thatStub = that.verifyStub();
thatopt = thatStub._getServiceClient().getOptions();
}
catch (Exception e)
{
thatopt = null;
}
if (thatopt == null) return false;
Options thisoptions = stub._getServiceClient().getOptions();
HttpTransportPropertiesImpl.Authenticator thisauth = (HttpTransportPropertiesImpl.Authenticator) thisoptions
.getProperty(HTTPConstants.AUTHENTICATE);
HttpTransportPropertiesImpl.Authenticator thatauth = (HttpTransportPropertiesImpl.Authenticator) thatopt
.getProperty(HTTPConstants.AUTHENTICATE);
if (!EqualsUtil.areSameNullState(thisauth, thatauth)) return false;
return EqualsUtil.areEqual(thisoptions.getTo().toString(), thatopt.getTo().toString())
&& EqualsUtil.areEqual(thisoptions.getProperty(HTTPConstants.SO_TIMEOUT), thatopt.getProperty(HTTPConstants.SO_TIMEOUT))
&& EqualsUtil.areEqual(thisoptions.getProperty(HTTPConstants.CONNECTION_TIMEOUT),
thatopt.getProperty(HTTPConstants.CONNECTION_TIMEOUT))
&& EqualsUtil.areEqual(thisoptions.getProperty(org.apache.axis2.transport.http.HTTPConstants.CHUNKED),
thatopt.getProperty(org.apache.axis2.transport.http.HTTPConstants.CHUNKED))
&& (thisauth != null
? (EqualsUtil.areEqual(thisauth.getUsername(), thatauth.getUsername())
&& EqualsUtil.areEqual(thisauth.getPassword(), thatauth.getPassword()))
: true);
}
/*
* (non-Javadoc)
*
* @see org.hpccsystems.ws.client.utils.DataSingleton#hashCode()
*/
@Override
public int hashCode()
{
int result = HashCodeUtil.SEED;
if (hasInitError()) return result = HashCodeUtil.hash(result, getInitError());
Options ops = stub._getServiceClient().getOptions();
result = HashCodeUtil.hash(result, ops.getTo());
HttpTransportPropertiesImpl.Authenticator thisauth = (HttpTransportPropertiesImpl.Authenticator) ops.getProperty(HTTPConstants.AUTHENTICATE);
result = HashCodeUtil.hash(result, thisauth == null ? "" : thisauth.getUsername());
result = HashCodeUtil.hash(result, thisauth == null ? "" : thisauth.getPassword());
result = HashCodeUtil.hash(result, ops.getProperty(HTTPConstants.SO_TIMEOUT));
result = HashCodeUtil.hash(result, ops.getProperty(HTTPConstants.CONNECTION_TIMEOUT));
return result;
}
/*
* (non-Javadoc)
*
* @see org.hpccsystems.ws.client.utils.DataSingleton#isComplete()
*/
@Override
protected boolean isComplete()
{
// TODO Auto-generated method stub
return false;
}
/*
* (non-Javadoc)
*
* @see org.hpccsystems.ws.client.utils.DataSingleton#fastRefresh()
*/
@Override
protected void fastRefresh()
{
// TODO Auto-generated method stub
}
/*
* (non-Javadoc)
*
* @see org.hpccsystems.ws.client.utils.DataSingleton#fullRefresh()
*/
@Override
protected void fullRefresh()
{
// TODO Auto-generated method stub
}
/**
* Sets the stub connection TO.
*
* @param millis
* the new stub connection TO
* @throws AxisFault
* the axis fault
*/
protected void setStubConnectionTO(int millis) throws AxisFault
{
Options opt = stub._getServiceClient().getOptions();
opt.setProperty(HTTPConstants.CONNECTION_TIMEOUT, millis);
stub._getServiceClient().setOptions(opt);
}
/**
* Gets the stub connection TO.
*
* @return the stub connection TO
* @throws AxisFault
* the axis fault
*/
protected Integer getStubConnectionTO() throws AxisFault
{
Integer to = null;
if (stub != null)
{
Options opt = stub._getServiceClient().getOptions();
try
{
to = (Integer) opt.getProperty(HTTPConstants.CONNECTION_TIMEOUT);
}
catch (Exception e)
{}
}
return to;
}
/**
* Sets the stub options.
*
* @param thestub
* the thestub
* @param connection
* the connection
* @return the stub
* @throws AxisFault
* the axis fault
*/
static public Stub setStubOptions(Stub thestub, Connection connection) throws AxisFault
{
Options opt = thestub._getServiceClient().getOptions();
opt.setProperty(HTTPConstants.SO_TIMEOUT, connection.getSocketTimeoutMilli());
opt.setProperty(HTTPConstants.CONNECTION_TIMEOUT, connection.getConnectTimeoutMilli());
opt = setClientAuth(connection.getUserName(), connection.getPassword(), opt);
opt.setProperty(org.apache.axis2.transport.http.HTTPConstants.CHUNKED, Boolean.FALSE);
thestub._getServiceClient().setOptions(opt);
return thestub;
}
/**
* Sets the client auth.
*
* @param user
* the user
* @param pass
* the pass
* @param opt
* the opt
* @return the options
*/
static public Options setClientAuth(String user, String pass, Options opt)
{
if (user != null && pass != null && opt != null)
{
HttpTransportPropertiesImpl.Authenticator basicAuth = new HttpTransportPropertiesImpl.Authenticator();
basicAuth.setUsername(user);
basicAuth.setPassword(pass);
basicAuth.setPreemptiveAuthentication(true);
opt.setProperty(HTTPConstants.AUTHENTICATE, basicAuth);
opt.setProperty(HttpTransportPropertiesImpl.Authenticator.BASIC, basicAuth);
}
return opt;
}
/**
* Logs and throws EspSoapFaultWrapper.
*
* @param e
* the e
* @throws EspSoapFaultWrapper
* the esp soap fault wrapper
*/
protected void handleEspSoapFaults(EspSoapFaultWrapper e) throws EspSoapFaultWrapper
{
if (e != null) handleEspSoapFaults(e, null);
}
/**
* Logs and throws EspSoapFaultWrapper, if local message provided, added as wsclientmessage.
*
* @param e
* the e
* @param message
* the message
* @throws EspSoapFaultWrapper
* the esp soap fault wrapper
*/
protected void handleEspSoapFaults(EspSoapFaultWrapper e, String message) throws EspSoapFaultWrapper
{
if (e != null)
{
if (message != null && !message.isEmpty()) e.setWsClientMessage(message);
log.error(e.toString());
throw e;
}
}
/**
* Handle esp exceptions.
*
* @param exp
* the exp
* @param message
* the message
* @throws ArrayOfEspExceptionWrapper
* the array of esp exception wrapper
*/
protected void handleEspExceptions(ArrayOfEspExceptionWrapper exp, String message) throws ArrayOfEspExceptionWrapper
{
if (exp == null || exp.getExceptions() == null || exp.getExceptions().size() <= 0) return;
if (message != null && !message.isEmpty()) exp.setWsClientMessage(message);
log.error(exp.toString());
throw exp;
}
/**
* Handle esp exceptions.
*
* @param exp
* the exp
* @throws ArrayOfEspExceptionWrapper
* the array of esp exception wrapper
*/
protected void handleEspExceptions(ArrayOfEspExceptionWrapper exp) throws ArrayOfEspExceptionWrapper
{
handleEspExceptions(exp, null);
}
/**
* Logs and throws arrayofeclexceptionwrapper without localized message response from WS client.
*
* @param eclexceptions
* the eclexceptions
* @throws Exception
* the exception
* @throws ArrayOfECLExceptionWrapper
* the array of ECL exception wrapper
*/
protected void handleECLExceptions(ArrayOfECLExceptionWrapper eclexceptions) throws Exception, ArrayOfECLExceptionWrapper
{
handleECLExceptions(eclexceptions, null);
}
/**
* Logs and throws arrayofeclexceptionwrapper with localized message response from WS client.
*
* @param eclExceptions
* - the array of ECLException objects to throw
* @param message
* - the prefix message
* @throws Exception
* the exception
* @throws ArrayOfECLExceptionWrapper
* the array of ECL exception wrapper
*/
protected void handleECLExceptions(ArrayOfECLExceptionWrapper eclExceptions, String message) throws Exception, ArrayOfECLExceptionWrapper
{
if (eclExceptions == null || eclExceptions.getECLException() == null || eclExceptions.getECLException().size() <= 0) return;
if (message != null && !message.isEmpty()) eclExceptions.setWsClientMessage(message);
log.error(eclExceptions.toString());
throw eclExceptions;
}
}