com.unboundid.scim.data.Entry Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of scim-sdk Show documentation
Show all versions of scim-sdk Show documentation
The UnboundID SCIM SDK is a library that may be used to interact with various
types of SCIM-enabled endpoints (such as the UnboundID server products) to
perform lightweight, cloud-based identity management via the SCIM Protocol.
See http://www.simplecloud.info for more information.
/*
* Copyright 2011-2016 UnboundID Corp.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.scim.data;
import com.unboundid.scim.schema.AttributeDescriptor;
import com.unboundid.scim.sdk.InvalidResourceException;
import com.unboundid.scim.sdk.SCIMAttribute;
import com.unboundid.scim.sdk.SCIMAttributeValue;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
/**
* Represents a standard value of a multi-valued attribute.
*
* @param The value type.
*/
public final class Entry
{
/**
* The AttributeValueResolver that resolves SCIM attribute values
* to/from String valued Entry instances.
*/
public static final AttributeValueResolver>
STRINGS_RESOLVER =
new AttributeValueResolver>() {
/**
* {@inheritDoc}
*/
@Override
public Entry toInstance(final SCIMAttributeValue value) {
String v =
value.getSubAttributeValue("value", STRING_RESOLVER);
String t =
value.getSubAttributeValue("type", STRING_RESOLVER);
Boolean p =
value.getSubAttributeValue("primary", BOOLEAN_RESOLVER);
String d =
value.getSubAttributeValue("display", STRING_RESOLVER);
String o =
value.getSubAttributeValue("operation", STRING_RESOLVER);
return new Entry(v, t, p == null ? false : p, d, o);
}
/**
* {@inheritDoc}
*/
@Override
public SCIMAttributeValue fromInstance(
final AttributeDescriptor attributeDescriptor,
final Entry value) throws InvalidResourceException {
final List subAttributes =
new ArrayList(5);
if (value.value != null)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("value"),
SCIMAttributeValue.createStringValue(value.value)));
}
if (value.primary)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("primary"),
SCIMAttributeValue.createBooleanValue(value.primary)));
}
if (value.type != null)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("type"),
SCIMAttributeValue.createStringValue(value.type)));
}
if(value.display != null)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("display"),
SCIMAttributeValue.createStringValue(value.display)));
}
if(value.operation != null)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("operation"),
SCIMAttributeValue.createStringValue(value.operation)));
}
return SCIMAttributeValue.createComplexValue(subAttributes);
}
};
/**
* The AttributeValueResolver that resolves SCIM attribute values
* to/from Boolean valued Entry instances.
*/
public static final AttributeValueResolver>
BOOLEANS_RESOLVER =
new AttributeValueResolver>() {
/**
* {@inheritDoc}
*/
@Override
public Entry toInstance(final SCIMAttributeValue value) {
Boolean v =
value.getSubAttributeValue("value", BOOLEAN_RESOLVER);
String t =
value.getSubAttributeValue("type", STRING_RESOLVER);
Boolean p =
value.getSubAttributeValue("primary", BOOLEAN_RESOLVER);
String d =
value.getSubAttributeValue("display", STRING_RESOLVER);
String o =
value.getSubAttributeValue("operation", STRING_RESOLVER);
return new Entry(v, t, p == null ? false : p, d, o);
}
/**
* {@inheritDoc}
*/
@Override
public SCIMAttributeValue fromInstance(
final AttributeDescriptor attributeDescriptor,
final Entry value) throws InvalidResourceException {
final List subAttributes =
new ArrayList(5);
if (value.value != null)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("value"),
SCIMAttributeValue.createBooleanValue(value.value)));
}
if (value.primary)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("primary"),
SCIMAttributeValue.createBooleanValue(value.primary)));
}
if (value.type != null)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("type"),
SCIMAttributeValue.createStringValue(value.type)));
}
if(value.display != null)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("display"),
SCIMAttributeValue.createStringValue(value.display)));
}
if(value.operation != null)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("operation"),
SCIMAttributeValue.createStringValue(value.operation)));
}
return SCIMAttributeValue.createComplexValue(subAttributes);
}
};
/**
* The AttributeValueResolver that resolves SCIM attribute values
* to/from byte[] valued Entry instances.
*/
public static final AttributeValueResolver>
BINARIES_RESOLVER =
new AttributeValueResolver>() {
/**
* {@inheritDoc}
*/
@Override
public Entry toInstance(final SCIMAttributeValue value) {
byte[] v =
value.getSubAttributeValue("value", BINARY_RESOLVER);
String t =
value.getSubAttributeValue("type", STRING_RESOLVER);
Boolean p =
value.getSubAttributeValue("primary", BOOLEAN_RESOLVER);
String d =
value.getSubAttributeValue("display", STRING_RESOLVER);
String o =
value.getSubAttributeValue("operation", STRING_RESOLVER);
return new Entry(v, t, p == null ? false : p, d, o);
}
/**
* {@inheritDoc}
*/
@Override
public SCIMAttributeValue fromInstance(
final AttributeDescriptor attributeDescriptor,
final Entry value) throws InvalidResourceException {
final List subAttributes =
new ArrayList(5);
if (value.value != null)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("value"),
SCIMAttributeValue.createBinaryValue(value.value)));
}
if (value.primary)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("primary"),
SCIMAttributeValue.createBooleanValue(value.primary)));
}
if (value.type != null)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("type"),
SCIMAttributeValue.createStringValue(value.type)));
}
if(value.display != null)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("display"),
SCIMAttributeValue.createStringValue(value.display)));
}
if(value.operation != null)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("operation"),
SCIMAttributeValue.createStringValue(value.operation)));
}
return SCIMAttributeValue.createComplexValue(subAttributes);
}
};
/**
* The AttributeValueResolver that resolves SCIM attribute values
* to/from Date valued Entry instances.
*/
public static final AttributeValueResolver>
DATES_RESOLVER =
new AttributeValueResolver>() {
/**
* {@inheritDoc}
*/
@Override
public Entry toInstance(final SCIMAttributeValue value) {
Date v =
value.getSubAttributeValue("value", DATE_RESOLVER);
String t =
value.getSubAttributeValue("type", STRING_RESOLVER);
Boolean p =
value.getSubAttributeValue("primary", BOOLEAN_RESOLVER);
String d =
value.getSubAttributeValue("display", STRING_RESOLVER);
String o =
value.getSubAttributeValue("operation", STRING_RESOLVER);
return new Entry(v, t, p == null ? false : p, d, o);
}
/**
* {@inheritDoc}
*/
@Override
public SCIMAttributeValue fromInstance(
final AttributeDescriptor attributeDescriptor,
final Entry value) throws InvalidResourceException {
final List subAttributes =
new ArrayList(5);
if (value.value != null)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("value"),
SCIMAttributeValue.createDateValue(value.value)));
}
if (value.primary)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("primary"),
SCIMAttributeValue.createBooleanValue(value.primary)));
}
if (value.type != null)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("type"),
SCIMAttributeValue.createStringValue(value.type)));
}
if(value.display != null)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("display"),
SCIMAttributeValue.createStringValue(value.display)));
}
if(value.operation != null)
{
subAttributes.add(
SCIMAttribute.create(
attributeDescriptor.getSubAttribute("operation"),
SCIMAttributeValue.createStringValue(value.operation)));
}
return SCIMAttributeValue.createComplexValue(subAttributes);
}
};
private T value;
private boolean primary;
private String type;
private String display;
private String operation;
/**
* Constructs an entry instance with the specified information.
*
* @param value The primary value of this attribute.
* @param type The type of attribute for this instance, usually used to
* label the preferred function of the given resource.
*/
public Entry(final T value, final String type) {
this(value, type, false, null, null);
}
/**
* Constructs an entry instance with the specified information.
*
* @param value The primary value of this attribute.
* @param type The type of attribute for this instance, usually used to
* label the preferred function of the given resource.
* @param primary A Boolean value indicating whether this instance of the
* multi-valued Attribute is the primary or preferred value of
* for this attribute.
*/
public Entry(final T value, final String type, final boolean primary) {
this(value, type, primary, null, null);
}
/**
* Constructs an entry instance with the specified information.
*
* @param value The primary value of this attribute.
* @param type The type of attribute for this instance, usually used to
* label the preferred function of the given resource.
* @param primary A Boolean value indicating whether this instance of the
* multi-valued Attribute is the primary or preferred value of
* for this attribute.
* @param display A human readable name, primarily used for display purposes
* where the value is an opaque or complex type such as an id.
*/
public Entry(final T value, final String type, final boolean primary,
final String display) {
this(value, type, primary, display, null);
}
/**
* Constructs an entry instance with the specified information.
*
* @param value The primary value of this attribute.
* @param type The type of attribute for this instance, usually used to
* label the preferred function of the given resource.
* @param primary A Boolean value indicating whether this instance of the
* multi-valued Attribute is the primary or preferred value of
* for this attribute.
* @param display A human readable name, primarily used for display purposes
* where the value is an opaque or complex type such as an id.
* @param operation The operation to perform on the multi-valued attribute
* during a PATCH request.
*/
public Entry(final T value, final String type, final boolean primary,
final String display, final String operation) {
this.value = value;
this.type = type;
this.primary = primary;
this.display = display;
this.operation = operation;
}
/**
* Whether this instance of the multi-valued Attribute is the primary or
* preferred value of for this attribute.
*
* @return true if this instance of the multi-valued Attribute is
* the primary or preferred value of for this attribute or
* false otherwise
*/
public boolean isPrimary() {
return primary;
}
/**
* Sets whether this instance of the multi-valued Attribute is the primary or
* preferred value of for this attribute.
*
* @param primary true if this instance of the multi-valued
* Attribute is the primary or preferred value of for this
* attribute or false otherwise.
*/
public void setPrimary(final boolean primary) {
this.primary = primary;
}
/**
* Retrieves the type of attribute for this instance, usually used to label
* the preferred function of the given resource.
*
* @return The type of attribute for this instance, usually used to label
* the preferred function of the given resource.
*/
public String getType() {
return type;
}
/**
* Sets the type of attribute for this instance, usually used to label
* the preferred function of the given resource.
*
* @param type The type of attribute for this instance, usually used to label
* the preferred function of the given resource.
*/
public void setType(final String type) {
this.type = type;
}
/**
* Retrieves the primary value of this attribute.
*
* @return The primary value of this attribute.
*/
public T getValue() {
return value;
}
/**
* Sets the primary value of this attribute.
*
* @param value The primary value of this attribute.
*/
public void setValue(final T value) {
this.value = value;
}
/**
* Retrieves the human readable name, primarily used for display purposes
* where the value is an opaque or complex type such as an id.
*
* @return The human readable name.
*/
public String getDisplay() {
return this.display;
}
/**
* Sets the human readable name, primarily used for display purposes
* where the value is an opaque or complex type such as an id.
*
* @param display The human readable name.
*/
public void setDisplay(final String display) {
this.display = display;
}
/**
* Retrieves the operation to perform on the multi-valued attribute during
* a PATCH request. A value of "delete" signifies that this instance should be
* removed from the Resource.
*
* @return The operation to perform on the multi-valued attribute during
* a PATCH request.
*/
public String getOperation()
{
return operation;
}
/**
* Sets the operation to perform on the multi-valued attribute during a
* PATCH request. A value of "delete" signifies that this instance should be
* removed from the Resource.
*
* @param operation The operation to perform on the multi-valued attribute
* during a PATCH request.
*/
public void setOperation(final String operation)
{
this.operation = operation;
}
/**
* {@inheritDoc}
*/
@Override
public boolean equals(final Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Entry entry = (Entry) o;
if (primary != entry.primary) {
return false;
}
if (type != null ? !type.equals(entry.type) : entry.type != null) {
return false;
}
if (value != null ? !value.equals(entry.value) : entry.value != null) {
return false;
}
if (display != null ? !display.equals(entry.display) :
entry.display != null) {
return false;
}
if (operation != null ? !operation.equals(entry.operation) :
entry.operation != null) {
return false;
}
return true;
}
/**
* {@inheritDoc}
*/
@Override
public int hashCode() {
int result = value != null ? value.hashCode() : 0;
result = 31 * result + (primary ? 1 : 0);
result = 31 * result + (type != null ? type.hashCode() : 0);
result = 31 * result + (display != null ? display.hashCode() : 0);
result = 31 * result + (operation != null ? operation.hashCode() : 0);
return result;
}
/**
* {@inheritDoc}
*/
@Override
public String toString() {
return "Entry{" +
"value=" + value +
", type='" + type + '\'' +
", primary=" + primary +
", display=" + display +
", operation=" + operation +
'}';
}
}