Package com.ironcorelabs.tenantsecurity.kms.v1

Class DocumentMetadata

java.lang.Object

com.ironcorelabs.tenantsecurity.kms.v1.DocumentMetadata

public class DocumentMetadata
extends Object

Holds metadata fields as part of an encrypted document. Each encrypted document will have metadata that associates it to a tenant ID, which service is accessing the data, its classification, as well as optional fields for other arbitrary key/value pairs and a request ID to send to the Tenant Security Proxy.

Constructor Summary

Constructors

Constructor	Description
DocumentMetadata(String tenantId, String requestingUserOrServiceId, String dataLabel)	Constructor for DocumentMetadata class which has no additional metadata.
DocumentMetadata(String tenantId, String requestingUserOrServiceId, String dataLabel, String requestId)	Constructor for DocumentMetadata class which contains a unique request ID to send to the Tenant Security Proxy.
DocumentMetadata(String tenantId, String requestingUserOrServiceId, String dataLabel, Map<String,String> otherData)	Constructor for DocumentMetadata class which contains arbitrary key/value pairs to send to the Tenant Security Proxy.
DocumentMetadata(String tenantId, String requestingUserOrServiceId, String dataLabel, Map<String,String> otherData, String requestId)	Constructor for DocumentMetadata class which contains arbitrary key/value pairs and a unique request ID to send to the Tenant Security Proxy.
DocumentMetadata(String tenantId, String requestingUserOrServiceId, String dataLabel, Map<String,String> otherData, String requestId, String sourceIp, String objectId)	Constructor for DocumentMetadata class which contains arbitrary key/value pairs and a unique request ID to send to the Tenant Security Proxy.

Method Summary

Modifier and Type	Method	Description
final String	getDataLabel()	Get the data classification label.
final Map<String,String>	getOtherData()	Get any other metadata.
final String	getRequestId()	Get the provided request ID
final String	getRequestingUserOrServiceId()	Get the requesting user or service ID.
final String	getTenantId()	Get the tenant ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DocumentMetadata

public DocumentMetadata(String tenantId,
 String requestingUserOrServiceId,
 String dataLabel,
 Map<String,String> otherData,
 String requestId,
 String sourceIp,
 String objectId)
                 throws IllegalArgumentException

Constructor for DocumentMetadata class which contains arbitrary key/value pairs and a unique request ID to send to the Tenant Security Proxy.

Parameters:

tenantId - Unique ID of tenant that is performing the operation.

requestingUserOrServiceId - Unique ID of user/service that is processing data.

dataLabel - Classification of data being processed.

otherData - Additional String key/value pairs to add to metadata.

requestId - Unique ID that ties host application request ID to Tenant Security Proxy logs.

sourceIp - IP address of the initiator of this request.

objectId - ID of the object being acted on in the host system.

Throws:

IllegalArgumentException - If the provided tenantId is not set

DocumentMetadata

public DocumentMetadata(String tenantId,
 String requestingUserOrServiceId,
 String dataLabel,
 Map<String,String> otherData,
 String requestId)

Constructor for DocumentMetadata class which contains arbitrary key/value pairs and a unique request ID to send to the Tenant Security Proxy.

Parameters:

tenantId - Unique ID of tenant that is performing the operation.

requestingUserOrServiceId - Unique ID of user/service that is processing data.

dataLabel - Classification of data being processed.

otherData - Additional String key/value pairs to add to metadata.

requestId - Unique ID that ties host application request ID to Tenant Security Proxy logs.

Throws:

IllegalArgumentException - If the provided tenantId is not set

DocumentMetadata

public DocumentMetadata(String tenantId,
 String requestingUserOrServiceId,
 String dataLabel,
 Map<String,String> otherData)
                 throws IllegalArgumentException

Constructor for DocumentMetadata class which contains arbitrary key/value pairs to send to the Tenant Security Proxy.

Parameters:

tenantId - Unique ID of tenant that is performing the operation.

requestingUserOrServiceId - Unique ID of user/service that is processing data.

dataLabel - Classification of data being processed.

otherData - Additional String key/value pairs to add to metadata.

Throws:

IllegalArgumentException - If the provided tenantId is not set

DocumentMetadata

public DocumentMetadata(String tenantId,
 String requestingUserOrServiceId,
 String dataLabel,
 String requestId)

Constructor for DocumentMetadata class which contains a unique request ID to send to the Tenant Security Proxy.

Parameters:

tenantId - Unique ID of tenant that is performing the operation.

requestingUserOrServiceId - Unique ID of user/service that is processing data.

dataLabel - Classification of data being processed.

requestId - Unique ID that ties host application request ID to Tenant Security Proxy logs.

Throws:

IllegalArgumentException - If the provided tenantId is not set

DocumentMetadata

public DocumentMetadata(String tenantId,
 String requestingUserOrServiceId,
 String dataLabel)

Constructor for DocumentMetadata class which has no additional metadata.

Parameters:

tenantId - Unique ID of tenant that is performing the operation.

requestingUserOrServiceId - Unique ID of user/service that is processing data.

dataLabel - Classification of data being processed.

Throws:

IllegalArgumentException - If the provided tenantId is not set

Method Details

getTenantId

public final String getTenantId()

Get the tenant ID.

Returns:

Metadata tenant ID

getRequestingUserOrServiceId

public final String getRequestingUserOrServiceId()

Get the requesting user or service ID.

Returns:

Requesting user or service ID

getRequestId

public final String getRequestId()

Get the provided request ID

Returns:

Unique ID that ties host application request ID to Tenant Security Proxy logs.

getDataLabel

public final String getDataLabel()

Get the data classification label.

Returns:

Data classification label

getOtherData

public final Map<String,String> getOtherData()

Get any other metadata.

Returns:

Any other key/value metadata