com.nimbusds.oauth2.sdk.id.Identifier Maven / Gradle / Ivy
Show all versions of oauth2-oidc-sdk Show documentation
/*
* oauth2-oidc-sdk
*
* Copyright 2012-2016, Connect2id Ltd and contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use
* this file except in compliance with the License. You may obtain a copy of the
* License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed
* under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package com.nimbusds.oauth2.sdk.id;
import java.io.Serializable;
import java.security.SecureRandom;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import net.minidev.json.JSONAware;
import net.minidev.json.JSONValue;
import com.nimbusds.jose.util.Base64URL;
import com.nimbusds.oauth2.sdk.util.StringUtils;
/**
* The base class for representing identifiers and identities. Provides
* constructors that generate Base64URL-encoded secure random identifier
* values.
*
* Extending classes must override the {@link #equals} method.
*/
public class Identifier implements Serializable, Comparable, JSONAware {
private static final long serialVersionUID = 365052911829193101L;
/**
* The default byte length of generated identifiers.
*/
public static final int DEFAULT_BYTE_LENGTH = 32;
/**
* Returns a string list representation of the specified identifier
* collection.
*
* @param ids The identifiers, {@code null} if not specified.
*
* @return The string list, empty list if not specified.
*/
public static List toStringList(final Collection ids) {
if (ids == null) {
return Collections.emptyList();
}
List stringList = new ArrayList<>(ids.size());
for (Identifier id: ids) {
stringList.add(id.getValue());
}
return stringList;
}
/**
* The secure random generator.
*/
protected static final SecureRandom secureRandom = new SecureRandom();
/**
* The identifier value.
*/
private final String value;
/**
* Creates a new identifier with the specified value.
*
* @param value The identifier value. Must not be {@code null} or empty
* string.
*/
public Identifier(final String value) {
if (StringUtils.isBlank(value))
throw new IllegalArgumentException("The value must not be null or empty string");
this.value = value;
}
/**
* Creates a new identifier with a randomly generated value of the
* specified byte length, Base64URL-encoded.
*
* @param byteLength The byte length of the value to generate. Must be
* greater than one.
*/
public Identifier(final int byteLength) {
if (byteLength < 1)
throw new IllegalArgumentException("The byte length must be a positive integer");
byte[] n = new byte[byteLength];
secureRandom.nextBytes(n);
value = Base64URL.encode(n).toString();
}
/**
* Creates a new identifier with a randomly generated 256-bit
* (32-byte) value, Base64URL-encoded.
*/
public Identifier() {
this(DEFAULT_BYTE_LENGTH);
}
/**
* Returns the value of this identifier.
*
* @return The value.
*/
public String getValue() {
return value;
}
/**
* Returns the JSON string representation of this identifier.
*
* @return The JSON string.
*/
@Override
public String toJSONString() {
return "\"" + JSONValue.escape(value) + '"';
}
/**
* @see #getValue
*/
@Override
public String toString() {
return getValue();
}
@Override
public int compareTo(final Identifier other) {
return getValue().compareTo(other.getValue());
}
@Override
public boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
Identifier that = (Identifier) o;
return getValue() != null ? getValue().equals(that.getValue()) : that.getValue() == null;
}
@Override
public int hashCode() {
return getValue() != null ? getValue().hashCode() : 0;
}
}