org.hpccsystems.ws.client.HPCCWsStoreClient 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 java.rmi.RemoteException;
import java.util.Properties;
import javax.crypto.Cipher;
import org.apache.axis2.AxisFault;
import org.apache.axis2.client.Stub;
import org.hpccsystems.commons.utils.CryptoHelper;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.CreateStoreRequest;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.CreateStoreResponse;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.DeleteNamespaceRequest;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.DeleteNamespaceResponse;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.DeleteRequest;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.DeleteResponse;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.EspSoapFault;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.FetchAllRequest;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.FetchAllResponse;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.FetchKeyMDRequest;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.FetchKeyMDResponse;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.FetchRequest;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.FetchResponse;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.KVPair;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.KeySet_type0;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.ListKeysRequest;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.ListKeysResponse;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.ListNamespacesRequest;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.ListNamespacesResponse;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.Namespaces_type0;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.Pairs_type0;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.Pairs_type1;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.SetRequest;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.SetResponse;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.WsstorePingRequest;
import org.hpccsystems.ws.client.gen.axis2.wsstore.v1_02.WsstoreStub;
import org.hpccsystems.ws.client.utils.Connection;
import org.hpccsystems.ws.client.wrappers.ArrayOfEspExceptionWrapper;
/**
* Facilitates access to HPCC Systems key/value based Storage.
*
* 7.x+ HPCC Systems deployments are capable of exposing a light-weight
* in-memory key/value store system.
*
* Supported actions include listing all namespaces, creating key store,
* setting/fetching/deleting by key, and setting encrypted values, and more.
*/
public class HPCCWsStoreClient extends BaseHPCCWsClient
{
// private static final Logger log = LogManager.getLogger(HPCCWsStoreClient.class);
/** Constant WSStoreWSDLURI="/wsstore" */
public static final String WSStoreWSDLURI = "/wsstore";
private static int DEFAULTSERVICEPORT = -1;
private static String WSDLURL = null;
/**
* Load WSDLURL.
*/
private static void loadWSDLURL()
{
try
{
WSDLURL = getServiceWSDLURL(new WsstoreStub());
DEFAULTSERVICEPORT = (new URL(WSDLURL)).getPort();
}
catch (AxisFault | MalformedURLException e)
{
log.error("Unable to establish original WSDL URL");
log.error(e.getLocalizedMessage());
}
}
/**
* Gets the service URI.
*
* @return the service URI
*/
public String getServiceURI()
{
return WSStoreWSDLURI;
}
/**
* Gets the service WSDLURL.
*
* @return the service WSDLURL
*/
public static String getServiceWSDLURL()
{
if (WSDLURL == null)
{
loadWSDLURL();
}
return WSDLURL;
}
/**
* Gets the service WSDL port.
*
* @return the service WSDL port
*/
public static int getServiceWSDLPort()
{
if (WSDLURL == null)
{
loadWSDLURL();
}
return DEFAULTSERVICEPORT;
}
/**
* Gets the.
*
* @param connection
* the connection
* @return the HPCC ws store client
*/
public static HPCCWsStoreClient get(Connection connection)
{
return new HPCCWsStoreClient(connection);
}
/**
* Gets the.
*
* @param protocol
* the protocol
* @param targetHost
* the target host
* @param targetPort
* the target port
* @param user
* the user
* @param pass
* the pass
* @return the HPCC ws store client
*/
public static HPCCWsStoreClient get(String protocol, String targetHost, String targetPort, String user, String pass)
{
Connection conn = new Connection(protocol, targetHost, targetPort);
conn.setCredentials(user, pass);
return new HPCCWsStoreClient(conn);
}
/**
* Gets the.
*
* @param protocol
* the protocol
* @param targetHost
* the target host
* @param targetPort
* the target port
* @param user
* the user
* @param pass
* the pass
* @param timeout
* the timeout
* @return the HPCC ws store client
*/
public static HPCCWsStoreClient get(String protocol, String targetHost, String targetPort, String user, String pass, int timeout)
{
Connection conn = new Connection(protocol, targetHost, targetPort);
conn.setCredentials(user, pass);
conn.setConnectTimeoutMilli(timeout);
conn.setSocketTimeoutMilli(timeout);
return new HPCCWsStoreClient(conn);
}
/**
* Instantiates a new HPCC ws store client.
*
* @param baseConnection
* the base connection
*/
protected HPCCWsStoreClient(Connection baseConnection)
{
initWSStoreStub(baseConnection);
}
/**
* Initializes the service's underlying soap proxy. Should only be used by constructors
*
* @param connection
* the connection
*/
private void initWSStoreStub(Connection connection)
{
try
{
setActiveConnectionInfo(connection);
stub = setStubOptions(new WsstoreStub(connection.getBaseUrl() + WSStoreWSDLURI), connection);
}
catch (AxisFault e)
{
log.error("Could not initialize WsStoreStub- Review all HPCC connection values");
e.printStackTrace();
}
catch (Exception e)
{
log.error("Could not initialize WsStoreStub- Review all HPCC connection values");
if (!e.getLocalizedMessage().isEmpty())
{
initErrMessage = e.getLocalizedMessage();
log.error(e.getLocalizedMessage());
}
}
}
/**
* Ping.
*
* @return true, if successful
* @throws java.lang.Exception
* the exception
*/
public boolean ping() throws Exception
{
verifyStub();
WsstorePingRequest request = new WsstorePingRequest();
try
{
((WsstoreStub) stub).ping(request);
}
catch (Exception e)
{
log.error(e.getLocalizedMessage());
return false;
}
return true;
}
/**
* List namespaces.
*
* @param storename
* the storename
* @param global
* the global
* @return the string[]
* @throws java.lang.Exception
* the exception
* @throws org.hpccsystems.ws.client.wrappers.ArrayOfEspExceptionWrapper
* the array of esp exception wrapper
*/
public String[] listNamespaces(String storename, boolean global) throws Exception, ArrayOfEspExceptionWrapper
{
String namespaces[] = null;
ListNamespacesRequest request = new ListNamespacesRequest();
request.setStoreName(storename);
request.setUserSpecific(global);
try
{
ListNamespacesResponse response = ((WsstoreStub) stub).listNamespaces(request);
if (response.getExceptions() != null)
handleEspExceptions(new ArrayOfEspExceptionWrapper(response.getExceptions()), "Could Not list wsstore namespaces");
Namespaces_type0 namespacesresp = response.getNamespaces();
if (namespacesresp != null) namespaces = namespacesresp.getNamespace();
}
catch (RemoteException e)
{
log.error("Could not list namespaces");
log.error(e);
}
catch (EspSoapFault e)
{
log.error("Could not list namespaces");
log.error(e);
}
return namespaces;
}
/**
* List NS keys.
*
* @param storename
* the storename
* @param namespace
* the namespace
* @param global
* the global
* @return the string[]
* @throws java.lang.Exception
* the exception
* @throws org.hpccsystems.ws.client.wrappers.ArrayOfEspExceptionWrapper
* the array of esp exception wrapper
*/
public String[] listNSKeys(String storename, String namespace, boolean global) throws Exception, ArrayOfEspExceptionWrapper
{
String keyset[] = null;
ListKeysRequest request = new ListKeysRequest();
request.setStoreName(storename);
request.setNamespace(namespace);
request.setUserSpecific(!global);
try
{
ListKeysResponse response = ((WsstoreStub) stub).listKeys(request);
if (response.getExceptions() != null) handleEspExceptions(new ArrayOfEspExceptionWrapper(response.getExceptions()),
"Could Not list keys for store: " + storename + " namespace: '" + namespace + "'");
KeySet_type0 keysetresp = response.getKeySet();
if (keysetresp != null) keyset = keysetresp.getKey();
}
catch (RemoteException e)
{
log.error("Could not list namespace keys");
log.error(e);
}
catch (EspSoapFault e)
{
log.error("Could not list namespace keys");
log.error(e);
}
return keyset;
}
/**
* Fetch value.
*
* @param storename
* the storename
* @param namespace
* the namespace
* @param key
* the key
* @param global
* the global
* @return the string
* @throws java.lang.Exception
* the exception
* @throws org.hpccsystems.ws.client.wrappers.ArrayOfEspExceptionWrapper
* the array of esp exception wrapper
*/
public String fetchValue(String storename, String namespace, String key, boolean global) throws Exception, ArrayOfEspExceptionWrapper
{
String value = null;
FetchRequest request = new FetchRequest();
request.setStoreName(storename);
request.setNamespace(namespace);
request.setUserSpecific(!global);
request.setKey(key);
try
{
FetchResponse response = ((WsstoreStub) stub).fetch(request);
if (response.getExceptions() != null) handleEspExceptions(new ArrayOfEspExceptionWrapper(response.getExceptions()),
"Could Fetch value for store: " + storename + " namespace: '" + namespace + "'" + " key: '" + key + "'");
value = response.getValue();
}
catch (RemoteException e)
{
log.error("Could not fetch value");
log.error(e);
}
catch (EspSoapFault e)
{
log.error("Could not fetch value");
log.error(e);
}
return value;
}
/**
* Fetch value encrypted.
*
* @param storename
* the storename
* @param namespace
* the namespace
* @param key
* the key
* @param global
* the global
* @param cipher
* the cipher
* @return the string
* @throws java.lang.Exception
* the exception
* @throws org.hpccsystems.ws.client.wrappers.ArrayOfEspExceptionWrapper
* the array of esp exception wrapper
*/
public String fetchValueEncrypted(String storename, String namespace, String key, boolean global, Cipher cipher)
throws Exception, ArrayOfEspExceptionWrapper
{
String value = fetchValue(storename, namespace, key, global);
if (value != null && !value.isEmpty())
{
value = CryptoHelper.decrypt(value, cipher);
}
else
{
throw new Exception("Could not fetch value");
}
return value;
}
/**
* Fetch value encrypted.
*
* @param storename
* the storename
* @param namespace
* the namespace
* @param key
* the key
* @param global
* the global
* @param secretKey
* - Must match the secret key used to encrypt this value
* @return the string
* @throws java.lang.Exception
* the exception
* @throws org.hpccsystems.ws.client.wrappers.ArrayOfEspExceptionWrapper
* the array of esp exception wrapper
*/
public String fetchValueEncrypted(String storename, String namespace, String key, boolean global, String secretKey)
throws Exception, ArrayOfEspExceptionWrapper
{
return fetchValueEncrypted(storename, namespace, secretKey, global, CryptoHelper.createDefaultCipher(secretKey, false));
}
/**
* Fetch key meta data.
*
* @param storename
* the storename
* @param namespace
* the namespace
* @param key
* the key
* @param global
* the global
* @return the properties
* @throws java.lang.Exception
* the exception
* @throws org.hpccsystems.ws.client.wrappers.ArrayOfEspExceptionWrapper
* the array of esp exception wrapper
*/
public Properties fetchKeyMetaData(String storename, String namespace, String key, boolean global) throws Exception, ArrayOfEspExceptionWrapper
{
Properties props = new Properties();
FetchKeyMDRequest request = new FetchKeyMDRequest();
request.setStoreName(storename);
request.setNamespace(namespace);
request.setUserSpecific(!global);
request.setKey(key);
try
{
FetchKeyMDResponse response = ((WsstoreStub) stub).fetchKeyMetadata(request);
if (response.getExceptions() != null) handleEspExceptions(new ArrayOfEspExceptionWrapper(response.getExceptions()),
"Could Fetch key meteadata for store: " + storename + " namespace: '" + namespace + "'" + " key: '" + key + "'");
Pairs_type1 pairs = response.getPairs();
if (pairs != null)
{
KVPair[] pair = pairs.getPair();
for (KVPair kvPair : pair)
{
props.setProperty(kvPair.getKey(), kvPair.getValue());
}
}
}
catch (RemoteException e)
{
e.printStackTrace();
}
catch (EspSoapFault e)
{
e.printStackTrace();
}
return props;
}
/**
* Fetch all NS keys.
*
* @param storename
* the storename
* @param namespace
* the namespace
* @param global
* the global
* @return the properties
* @throws java.lang.Exception
* the exception
* @throws org.hpccsystems.ws.client.wrappers.ArrayOfEspExceptionWrapper
* the array of esp exception wrapper
*/
public Properties fetchAllNSKeys(String storename, String namespace, boolean global) throws Exception, ArrayOfEspExceptionWrapper
{
Properties props = new Properties();
FetchAllRequest request = new FetchAllRequest();
request.setStoreName(storename);
request.setNamespace(namespace);
request.setUserSpecific(!global);
try
{
FetchAllResponse response = ((WsstoreStub) stub).fetchAll(request);
if (response.getExceptions() != null)
handleEspExceptions(new ArrayOfEspExceptionWrapper(response.getExceptions()),
"Could not fetch all namespaces keys for store: " + storename + " namespace: '" + namespace + "'");
Pairs_type0 pairs = response.getPairs();
if (pairs != null)
{
KVPair[] pair = pairs.getPair();
for (KVPair kvPair : pair)
{
props.setProperty(kvPair.getKey(), kvPair.getValue());
}
}
}
catch (RemoteException e)
{
e.printStackTrace();
}
catch (EspSoapFault e)
{
e.printStackTrace();
}
return props;
}
/**
* Sets the value.
*
* @param storename
* the storename
* @param namespace
* the namespace
* @param key
* the key
* @param value
* the value
* @param global
* the global
* @return true, if successful
* @throws java.lang.Exception
* the exception
* @throws org.hpccsystems.ws.client.wrappers.ArrayOfEspExceptionWrapper
* the array of esp exception wrapper
*/
public boolean setValue(String storename, String namespace, String key, String value, boolean global) throws Exception, ArrayOfEspExceptionWrapper
{
SetRequest request = new SetRequest();
request.setStoreName(storename);
request.setNamespace(namespace);
request.setKey(key);
request.setValue(value);
request.setUserSpecific(!global);
try
{
SetResponse response = ((WsstoreStub) stub).set(request);
if (response.getExceptions() != null) handleEspExceptions(new ArrayOfEspExceptionWrapper(response.getExceptions()),
"Could not Set " + key + "=" + value + " for store: " + storename + " namespace: '" + namespace + "'");
return response.getSuccess();
}
catch (RemoteException e)
{
e.printStackTrace();
}
catch (EspSoapFault e)
{
e.printStackTrace();
}
return false;
}
/**
* Sets the value encrypted.
*
* @param storename
* the storename
* @param namespace
* the namespace
* @param key
* the key
* @param value
* the value
* @param global
* the global
* @param cipher
* the cipher
* @return true, if successful
* @throws java.lang.Exception
* the exception
* @throws org.hpccsystems.ws.client.wrappers.ArrayOfEspExceptionWrapper
* the array of esp exception wrapper
*/
public boolean setValueEncrypted(String storename, String namespace, String key, String value, boolean global, Cipher cipher)
throws Exception, ArrayOfEspExceptionWrapper
{
return setValue(storename, namespace, key, CryptoHelper.encrypt(value, cipher), global);
}
/**
* Sets the value encrypted.
*
* @param storename
* the storename
* @param namespace
* the namespace
* @param key
* the key
* @param value
* the value
* @param global
* the global
* @param secretKey
* the secret key
* @return true, if successful
* @throws java.lang.Exception
* the exception
* @throws org.hpccsystems.ws.client.wrappers.ArrayOfEspExceptionWrapper
* the array of esp exception wrapper
*/
public boolean setValueEncrypted(String storename, String namespace, String key, String value, boolean global, String secretKey)
throws Exception, ArrayOfEspExceptionWrapper
{
return setValue(storename, namespace, key, CryptoHelper.encryptSHA512AESPKCS5Pad(value, secretKey), global);
}
/**
* Delete value.
*
* @param storename
* the storename
* @param namespace
* the namespace
* @param key
* the key
* @param global
* the global
* @return true, if successful
* @throws java.lang.Exception
* the exception
* @throws org.hpccsystems.ws.client.wrappers.ArrayOfEspExceptionWrapper
* the array of esp exception wrapper
*/
public boolean deleteValue(String storename, String namespace, String key, boolean global) throws Exception, ArrayOfEspExceptionWrapper
{
DeleteRequest request = new DeleteRequest();
request.setStoreName(storename);
request.setNamespace(namespace);
request.setKey(key);
request.setUserSpecific(!global);
try
{
DeleteResponse response = ((WsstoreStub) stub).delete(request);
if (response.getExceptions() != null) handleEspExceptions(new ArrayOfEspExceptionWrapper(response.getExceptions()),
"Could not delete " + key + " for store: " + storename + " namespace: '" + namespace + "'");
return response.getSuccess();
}
catch (RemoteException e)
{
e.printStackTrace();
}
catch (EspSoapFault e)
{
e.printStackTrace();
}
return false;
}
/**
* Delete namespace.
*
* @param storename
* the storename
* @param namespace
* the namespace
* @param global
* the global
* @param targetuser
* the targetuser
* @return true, if successful
* @throws java.lang.Exception
* the exception
* @throws org.hpccsystems.ws.client.wrappers.ArrayOfEspExceptionWrapper
* the array of esp exception wrapper
*/
public boolean deleteNamespace(String storename, String namespace, boolean global, String targetuser) throws Exception, ArrayOfEspExceptionWrapper
{
DeleteNamespaceRequest request = new DeleteNamespaceRequest();
request.setStoreName(storename);
request.setNamespace(namespace);
request.setTargetUser(targetuser);
request.setUserSpecific(!global);
try
{
DeleteNamespaceResponse response = ((WsstoreStub) stub).deleteNamespace(request);
if (response.getExceptions() != null)
handleEspExceptions(new ArrayOfEspExceptionWrapper(response.getExceptions()), "Could not delete namespace" + storename + "."
+ namespace + " (" + (global == true ? "global" : (targetuser != null && !targetuser.isEmpty()) ? targetuser : "user") + ")");
return response.getSuccess();
}
catch (RemoteException e)
{
e.printStackTrace();
}
catch (EspSoapFault e)
{
e.printStackTrace();
}
return false;
}
/**
* Creates the store.
*
* @param storename
* the storename
* @param description
* the description
* @param type
* the type
* @return true, if successful
* @throws java.lang.Exception
* the exception
* @throws org.hpccsystems.ws.client.wrappers.ArrayOfEspExceptionWrapper
* the array of esp exception wrapper
*/
public boolean createStore(String storename, String description, String type) throws Exception, ArrayOfEspExceptionWrapper
{
CreateStoreRequest request = new CreateStoreRequest();
request.setName(storename);
request.setDescription(description);
request.setType(type);
try
{
CreateStoreResponse response = ((WsstoreStub) stub).createStore(request);
if (response.getExceptions() != null)
handleEspExceptions(new ArrayOfEspExceptionWrapper(response.getExceptions()), "Could not create store " + storename);
return response.getSuccess();
}
catch (RemoteException e)
{
e.printStackTrace();
}
catch (EspSoapFault e)
{
e.printStackTrace();
}
return false;
}
/*
* (non-Javadoc)
*
* @see org.hpccsystems.ws.client.BaseHPCCWsClient#getDefaultStub()
*/
/** {@inheritDoc} */
@Override
public Stub getDefaultStub() throws AxisFault
{
return new WsstoreStub();
}
}