java.com.ionic.sdk.agent.request.updatekey.UpdateKeysResponse Maven / Gradle / Ivy
Show all versions of ionic-sdk Show documentation
package com.ionic.sdk.agent.request.updatekey;
import com.ionic.sdk.agent.key.AgentKey;
import com.ionic.sdk.agent.key.KeyAttributesMap;
import com.ionic.sdk.agent.key.KeyObligationsMap;
import com.ionic.sdk.agent.request.base.AgentResponseBase;
import com.ionic.sdk.core.value.Value;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
/**
* Represents the output for a request to the Ionic Machina
* Tools {@link com.ionic.sdk.agent.Agent#updateKeys(UpdateKeysRequest)} API call.
*
* The response will contain updated information about the {@link Key} objects involved in the request.
*
* The UpdateKey / UpdateKeys family of APIs allow for the mutable attributes associated with existing AES keys to
* be updated. Subsequent GetKey / GetKeys calls allow for the retrieval of the keys, via the key id, and receive any
* updates to the key's mutable attributes.
*
* See Machina Developers for
* more information about the UpdateKey operation.
*/
public class UpdateKeysResponse extends AgentResponseBase {
/**
* Represents a list of Key objects for an Agent.updateKeys() response.
*/
private final List keys;
/**
* Represents a list of Key objects for an Agent.updateKeys() response.
*/
private final List errors;
/**
* Constructor.
*/
public UpdateKeysResponse() {
super();
this.keys = new ArrayList();
this.errors = new ArrayList();
}
/**
* @return a list of Key objects for an Agent.updateKeys() response.
*/
public final List getKeys() {
return keys;
}
/**
* @return a list of Error objects for an Agent.updateKeys() response.
*/
public final List getErrors() {
return errors;
}
/**
* Add a key response object to the {@link UpdateKeysResponse}.
*
* @param key the object containing the parameters of the key response
*/
public final void add(final Key key) {
keys.add(key);
}
/**
* Add a error response object to the {@link UpdateKeysResponse}.
*
* @param error the object containing the parameters of the key response
*/
public final void add(final IonicError error) {
errors.add(error);
}
/**
* Retrieve the {@link UpdateKeysResponse.Key} record associated with the specified key tag.
*
* @param id a Machina key tag
* @return the matching {@link UpdateKeysResponse.Key} record, or null if not found
*/
public final UpdateKeysResponse.Key getKey(final String id) {
UpdateKeysResponse.Key key = null;
for (UpdateKeysResponse.Key keyIt : keys) {
if (id.equals(keyIt.getId())) {
key = keyIt;
break;
}
}
return key;
}
/**
* Retrieve the {@link UpdateKeysResponse.IonicError} record associated with the specified key tag.
*
* @param id a Machina key tag
* @return the matching {@link UpdateKeysResponse.IonicError} record, or null if not found
*/
public final UpdateKeysResponse.IonicError getError(final String id) {
UpdateKeysResponse.IonicError error = null;
for (UpdateKeysResponse.IonicError errorIt : errors) {
if (id.equals(errorIt.getKeyId())) {
error = errorIt;
break;
}
}
return error;
}
/** Value of serialVersionUID from maven coordinates "com.ionic:ionic-sdk:2.8.0". */
private static final long serialVersionUID = 7416884005935984946L;
/**
* Represents a discrete key response object in the context of a {@link UpdateKeysResponse}.
*/
public static class Key extends AgentKey implements Serializable {
/**
* The device id associated with the creation request.
*/
private String deviceId;
/**
* Constructor.
*/
public Key() {
super();
this.deviceId = "";
setOrigin("");
}
/**
* Constructor.
*
* @param agentKey the base key implementation
* @param deviceId the associated Ionic device id
* @param origin the origin of the key
*/
public Key(final AgentKey agentKey, final String deviceId, final String origin) {
super(agentKey);
this.deviceId = deviceId;
setOrigin(origin);
}
/**
* Constructor.
*
* @param id the specified key id to initialize with.
* @param key the specified key data to initialize with.
* @param deviceId the associated Ionic device id
* @throws NullPointerException When keyId or keyBytes are null.
*/
public Key(final String id, final byte[] key, final String deviceId) {
super(id, key);
this.setDeviceId(deviceId);
}
/**
* Constructor.
*
* @param id the specified key id to initialize with.
* @param key the specified key data to initialize with.
* @param deviceId the associated Ionic device id
* @param attributes the specified key attributes to initialize with.
* @param mutableAttributes the specified mutable attributes to initialize with.
* @param obligations the specified key obligations to initialize with.
* @param keyOrigin the origin of the key
*/
public Key(final String id, final byte[] key, final String deviceId, final KeyAttributesMap attributes,
final KeyAttributesMap mutableAttributes, final KeyObligationsMap obligations,
final String keyOrigin) {
super(id, key, attributes, mutableAttributes, obligations);
this.setDeviceId(deviceId);
this.setOrigin(keyOrigin);
}
/**
* Constructor.
*
* @param id the specified key id to initialize with.
* @param key the specified key data to initialize with.
* @param deviceId the associated Ionic device id
* @param attributes the specified key attributes to initialize with.
* @param mutableAttributes the specified mutable attributes to initialize with.
* @param obligations the specified key obligations to initialize with.
* @param keyOrigin the origin of the key
* @param attributesSigBase64FromServer the server signature applied to the immutable attributes
* @param mutableAttributesSigBase64FromServer the server signature applied to the mutable attributes
*/
@SuppressWarnings({"checkstyle:parameternumber"}) // Java JNI SDK API compatibility
public Key(final String id, final byte[] key, final String deviceId, final KeyAttributesMap attributes,
final KeyAttributesMap mutableAttributes, final KeyObligationsMap obligations,
final String keyOrigin,
final String attributesSigBase64FromServer, final String mutableAttributesSigBase64FromServer) {
super(id, key, attributes, mutableAttributes, obligations);
this.setDeviceId(deviceId);
this.setOrigin(keyOrigin);
this.setAttributesSigBase64FromServer(attributesSigBase64FromServer);
this.setMutableAttributesSigBase64FromServer(mutableAttributesSigBase64FromServer);
}
/**
* @return the device id associated with the creation request
*/
public final String getDeviceId() {
return deviceId;
}
/**
* Set the device ID.
*
* @param deviceId the device identifier to associate with this key
* The key attributes map.
*/
public final void setDeviceId(final String deviceId) {
this.deviceId = Value.defaultOnEmpty(deviceId, "");
}
/** Value of serialVersionUID from maven coordinates "com.ionic:ionic-sdk:2.8.0". */
private static final long serialVersionUID = -3431416299803402371L;
}
/**
* Represents a discrete error response object in the context of a {@link UpdateKeysResponse}.
*/
public static class IonicError implements Serializable {
/**
* A String denoting the id of the key.
*/
private String keyId;
/**
* The client error code (SDK client side error code).
*/
private int clientError;
/**
* The server error code provided by an Ionic server.
*/
private int serverError;
/**
* The server error message string provided by an Ionic server.
*/
private String serverMessage;
/**
* Constructor.
*
* @param keyId the key ID (also known as the key tag)
* @param clientError the client error code (SDK client side error code)
* @param serverError the server error code provided by an Ionic server
* @param serverMessage the server error message string provided by an Ionic server
*/
public IonicError(
final String keyId, final int clientError, final int serverError, final String serverMessage) {
this.keyId = keyId;
this.clientError = clientError;
this.serverError = serverError;
this.serverMessage = serverMessage;
}
/**
* @return The key ID (also known as the key tag).
*/
public final String getKeyId() {
return keyId;
}
/**
* Set the key ID (key tag).
*
* @param keyId The key ID (also known as the key tag)
*/
public final void setKeyId(final String keyId) {
this.keyId = keyId;
}
/**
* @return The client error code (SDK client side error code).
*/
public final int getClientError() {
return clientError;
}
/**
* Set the client error code (SDK client side error code).
*
* @param clientError The client error code (SDK client side error code)
*/
public final void setClientError(final int clientError) {
this.clientError = clientError;
}
/**
* @return The server error code provided by an Ionic server.
*/
public final int getServerError() {
return serverError;
}
/**
* Set the server error code provided by an Ionic server.
*
* @param serverError the server error code provided by an Ionic server
*/
public final void setServerError(final int serverError) {
this.serverError = serverError;
}
/**
* @return The server error message string provided by an Ionic server.
*/
public final String getServerMessage() {
return serverMessage;
}
/**
* Set the server error message string provided by an Ionic server.
*
* @param serverMessage the server error message string provided by an Ionic server
*/
public final void setServerMessage(final String serverMessage) {
this.serverMessage = serverMessage;
}
/** Value of serialVersionUID from maven coordinates "com.ionic:ionic-sdk:2.8.0". */
private static final long serialVersionUID = -4176159213618554197L;
}
}