org.osiam.resources.scim.Extension Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of connector4java Show documentation
Show all versions of connector4java Show documentation
Native Java API to connect to the REST based OSIAM services
/**
* The MIT License (MIT)
*
* Copyright (C) 2013-2016 tarent solutions GmbH
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package org.osiam.resources.scim;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.google.common.collect.ImmutableMap;
import org.osiam.resources.helper.ExtensionSerializer;
import java.io.Serializable;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.net.URI;
import java.nio.ByteBuffer;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import java.util.NoSuchElementException;
/**
* This class represents a schema extension.
*
* For more detailed information please look at the SCIM core schema 2.0, section 4
*
*/
@JsonSerialize(using = ExtensionSerializer.class)
public final class Extension implements Serializable {
private static final long serialVersionUID = -121658804932369438L;
@JsonIgnore
private final String urn;
private final Map fields;
@JsonCreator
private Extension(@JsonProperty("urn") String urn, @JsonProperty("fields") Map fields) {
this.urn = urn;
this.fields = fields != null ? ImmutableMap.copyOf(fields) : ImmutableMap.of();
}
private Extension(Builder builder) {
this(builder.urn, builder.fields);
}
/**
* Returns the URN of this extension.
*
* @return The URN
*/
public String getUrn() {
return urn;
}
/**
* Return the value for the field with a given name and type.
*
* @param field The name of the field to retrieve the value of.
* @param extensionFieldType The type of the field.
* @return The value for the field with the given name.
* @throws NoSuchElementException if this schema does not contain a field of the given name.
* @throws IllegalArgumentException if the given field is null or an empty string or if the extensionFieldType is null.
*/
public T getField(String field, ExtensionFieldType extensionFieldType) {
if (field == null || field.isEmpty()) {
throw new IllegalArgumentException("Invalid field name");
}
if (extensionFieldType == null) {
throw new IllegalArgumentException("Invalid field type");
}
if (!isFieldPresent(field)) {
throw new NoSuchElementException("Field " + field + " not valid in this extension");
}
return extensionFieldType.fromString(fields.get(field).value);
}
/**
* Return the value for the field with a given name as String.
*
* @param field The name of the field to retrieve the value of.
* @return The value for the field with the given name.
* @throws NoSuchElementException if this schema does not contain a field of the given name.
* @throws IllegalArgumentException if the given field is null or an empty string or if the extensionFieldType is null.
*/
public String getFieldAsString(String field) {
return getField(field, ExtensionFieldType.STRING);
}
/**
* Return the value for the field with a given name as boolean.
*
* @param field The name of the field to retrieve the value of.
* @return The value for the field with the given name.
* @throws NoSuchElementException if this schema does not contain a field of the given name.
* @throws IllegalArgumentException if the given field is null or an empty string or if the extensionFieldType is null.
*/
public boolean getFieldAsBoolean(String field) {
return getField(field, ExtensionFieldType.BOOLEAN);
}
/**
* Return the value for the field with a given name as ByteBuffer.
*
* @param field The name of the field to retrieve the value of.
* @return The value for the field with the given name.
* @throws NoSuchElementException if this schema does not contain a field of the given name.
* @throws IllegalArgumentException if the given field is null or an empty string or if the extensionFieldType is null.
*/
public ByteBuffer getFieldAsByteBuffer(String field) {
return getField(field, ExtensionFieldType.BINARY);
}
/**
* Return the value for the field with a given name as Date.
*
* @param field The name of the field to retrieve the value of.
* @return The value for the field with the given name.
* @throws NoSuchElementException if this schema does not contain a field of the given name.
* @throws IllegalArgumentException if the given field is null or an empty string or if the extensionFieldType is null.
*/
public Date getFieldAsDate(String field) {
return getField(field, ExtensionFieldType.DATE_TIME);
}
/**
* Return the value for the field with a given name as BigDecimal.
*
* @param field The name of the field to retrieve the value of.
* @return The value for the field with the given name.
* @throws NoSuchElementException if this schema does not contain a field of the given name.
* @throws IllegalArgumentException if the given field is null or an empty string or if the extensionFieldType is null.
*/
public BigDecimal getFieldAsDecimal(String field) {
return getField(field, ExtensionFieldType.DECIMAL);
}
/**
* Return the value for the field with a given name as BigInteger.
*
* @param field The name of the field to retrieve the value of.
* @return The value for the field with the given name.
* @throws NoSuchElementException if this schema does not contain a field of the given name.
* @throws IllegalArgumentException if the given field is null or an empty string or if the extensionFieldType is null.
*/
public BigInteger getFieldAsInteger(String field) {
return getField(field, ExtensionFieldType.INTEGER);
}
/**
* Return the value for the field with a given name as URI.
*
* @param field The name of the field to retrieve the value of.
* @return The value for the field with the given name.
* @throws NoSuchElementException if this schema does not contain a field of the given name.
* @throws IllegalArgumentException if the given field is null or an empty string or if the extensionFieldType is null.
*/
public URI getFieldAsReference(String field) {
return getField(field, ExtensionFieldType.REFERENCE);
}
/**
* Provides a {@link Map} containing the entries of the extension. Note that the returned {@link Map} is immutable.
*
* @return The Entries of this schema as an map.
*/
@JsonIgnore
public Map getFields() {
return fields;
}
/**
* Checks if the given field is present in this extension because not every field is mandatory (according to scim
* 2.0 spec).
*
* @param field Name of the field to check
* @return true if the given field is present, else false
*/
public boolean isFieldPresent(String field) {
return fields.containsKey(field);
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((fields == null) ? 0 : fields.hashCode());
result = prime * result + ((urn == null) ? 0 : urn.hashCode());
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
Extension other = (Extension) obj;
if (fields == null) {
if (other.fields != null) {
return false;
}
} else if (!fields.equals(other.fields)) {
return false;
}
if (urn == null) {
if (other.urn != null) {
return false;
}
} else if (!urn.equals(other.urn)) {
return false;
}
return true;
}
@Override
public String toString() {
StringBuilder stringPresentation = new StringBuilder();
stringPresentation.append("Extension [urn=").append(urn).append("{");
boolean firstEntry = true;
for (String key : fields.keySet()) {
Field field = fields.get(key);
if (!firstEntry) {
stringPresentation.append(", ");
}
firstEntry = false;
stringPresentation.append("field=").append(key).append("(")
.append("value=").append(field.getValue()).append(", type=")
.append(field.getType()).append(")");
}
stringPresentation.append("}]");
return stringPresentation.toString();
}
/**
* Builder class that is used to build {@link Extension} instances
*/
public static class Builder {
private String urn;
private Map fields = new HashMap<>();
/**
* Constructs an extension with the given urn.
*
* @param urn the urn of the extension
*/
public Builder(String urn) {
this.urn = urn;
}
/**
* Constructs an extension based on the given extension.
*
* @param extension existing extension
*/
public Builder(Extension extension) {
this.urn = extension.urn;
fields.putAll(extension.fields);
}
/**
* Sets the field specified by the given field name with the given value.
* Can only be set and saved if extension field is registered in the database
*
* @param fieldName the field name
* @param value the new value
* @return the builder itself
*/
public Builder setField(String fieldName, String value) {
setField(fieldName, value, ExtensionFieldType.STRING);
return this;
}
/**
* Sets the field specified by the given field name with the given value.
* Can only be set and saved if extension field is registered in the database
*
* @param fieldName the field name
* @param value the new value
* @return the builder itself
*/
public Builder setField(String fieldName, Boolean value) {
setField(fieldName, value, ExtensionFieldType.BOOLEAN);
return this;
}
/**
* Sets the field specified by the given field name with the given value.
* Can only be set and saved if extension field is registered in the database
*
* @param fieldName the field name
* @param value the new value
* @return the builder itself
*/
public Builder setField(String fieldName, ByteBuffer value) {
setField(fieldName, value, ExtensionFieldType.BINARY);
return this;
}
/**
* Sets the field specified by the given field name with the given value.
* Can only be set and saved if extension field is registered in the database
*
* @param fieldName the field name
* @param value the new value
* @return the builder itself
*/
public Builder setField(String fieldName, BigInteger value) {
setField(fieldName, value, ExtensionFieldType.INTEGER);
return this;
}
/**
* Sets the field specified by the given field name with the given value.
* Can only be set and saved if extension field is registered in the database
*
* @param fieldName the field name
* @param value the new value
* @return the builder itself
*/
public Builder setField(String fieldName, BigDecimal value) {
setField(fieldName, value, ExtensionFieldType.DECIMAL);
return this;
}
/**
* Sets the field specified by the given field name with the given value.
* Can only be set and saved if extension field is registered in the database
*
* @param fieldName the field name
* @param value the new value
* @return the builder itself
*/
public Builder setField(String fieldName, Date value) {
setField(fieldName, value, ExtensionFieldType.DATE_TIME);
return this;
}
/**
* Sets the field specified by the given field name with the given value.
* Can only be set and saved if extension field is registered in the database
*
* @param fieldName the field name
* @param value the new value
* @return the builder itself
*/
public Builder setField(String fieldName, URI value) {
setField(fieldName, value, ExtensionFieldType.REFERENCE);
return this;
}
/**
* Sets the field specified by the given field name with the given value of the given type.
* Can only be set and saved if extension field is registered in the database
*
* @param fieldName the field name
* @param value the new value
* @param type the scim type of the field
* @return the builder itself
*/
public Builder setField(String fieldName, T value, ExtensionFieldType type) {
if (fieldName == null || fieldName.isEmpty()) {
throw new IllegalArgumentException("The field name can't be null or empty.");
}
if (value == null) {
throw new IllegalArgumentException("The value can't be null.");
}
if (type == null) {
throw new IllegalArgumentException("The type can't be null.");
}
fields.put(fieldName, new Field(type, type.toString(value)));
return this;
}
/**
* removes one field and its value
*
* @param fieldName the field to be removed
* @return the builder itself
*/
public Builder removeField(String fieldName) {
fields.remove(fieldName);
return this;
}
public Extension build() {
return new Extension(this);
}
}
/**
* This class represents a field of an extension with its type and value. Instances of this class are immutable.
*/
public static final class Field implements Serializable {
private static final long serialVersionUID = 5733905110534921573L;
private final ExtensionFieldType type;
private final String value;
/**
* Constructs a new {@link Field} with the given type and value.
*
* @param type the type of the field
* @param value the value of the field
*/
public Field(ExtensionFieldType type, String value) {
this.type = type;
this.value = value;
}
/**
* Returns the type of the {@link Field}
*
* @return the type of the {@link Field}
*/
public ExtensionFieldType getType() {
return type;
}
/**
* Returns the value of the {@link Field}
*
* @return the value of the {@link Field}
*/
public String getValue() {
return value;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((type == null) ? 0 : type.hashCode());
result = prime * result + ((value == null) ? 0 : value.hashCode());
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
Field other = (Field) obj;
if (type == null) {
if (other.type != null) {
return false;
}
} else if (!type.equals(other.type)) {
return false;
}
if (value == null) {
if (other.value != null) {
return false;
}
} else if (!value.equals(other.value)) {
return false;
}
return true;
}
@Override
public String toString() {
return "Field [type=" + type + ", value=" + value + "]";
}
}
}