rdapit.pidsystem

Class HandleSystemRESTAdapter

java.lang.Object

rdapit.pidsystem.HandleSystemRESTAdapter

All Implemented Interfaces:

IIdentifierSystem

public class HandleSystemRESTAdapter
extends Object
implements IIdentifierSystem

Concrete adapter of an identifier system that connects to the Handle System through its native REST interface available from HS v8 on.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	authInfo
protected URI	baseURI
protected javax.ws.rs.client.Client	client
protected String	generatorPrefix
protected javax.ws.rs.client.WebTarget	handlesTarget
protected javax.ws.rs.client.WebTarget	individualHandleTarget
protected javax.ws.rs.client.WebTarget	rootTarget
static boolean	UNSAFE_SSL

Constructor Summary

Constructors

Constructor and Description
HandleSystemRESTAdapter(String baseURI, String userName, String userPassword, String generatorPrefix)
HandleSystemRESTAdapter(String baseURI, String userName, String userPassword, String generatorPrefix, boolean unsafe_ssl)

Method Summary

Methods

Modifier and Type	Method and Description
static HandleSystemRESTAdapter	configFromProperties(Properties properties) Factory method.
boolean	deletePID(String pid) Remove the given PID.
protected String	generatePIDName()
String	getGeneratorPrefix()
boolean	isIdentifierRegistered(String pid) Checks whether the given PID is already registered.
PIDInformation	queryAllProperties(String pid) Queries all properties from the given PID, independent of types.
PIDInformation	queryByType(String pid, TypeDefinition typeDefinition) Queries all properties of a given type available from the given PID.
String	queryProperty(String pid, PropertyDefinition propertyDefinition) Queries a single property from the given PID.
String	registerPID(Map<String,String> properties) Registers a new PID with given property values.

Methods inherited from class java.lang.Object

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

Field Detail

UNSAFE_SSL

public static final boolean UNSAFE_SSL

See Also:

Constant Field Values

baseURI

protected URI baseURI

authInfo

protected String authInfo

client

protected javax.ws.rs.client.Client client

generatorPrefix

protected String generatorPrefix

rootTarget

protected javax.ws.rs.client.WebTarget rootTarget

handlesTarget

protected javax.ws.rs.client.WebTarget handlesTarget

individualHandleTarget

protected javax.ws.rs.client.WebTarget individualHandleTarget

Constructor Detail

HandleSystemRESTAdapter

public HandleSystemRESTAdapter(String baseURI,
                       String userName,
                       String userPassword,
                       String generatorPrefix,
                       boolean unsafe_ssl)

HandleSystemRESTAdapter

public HandleSystemRESTAdapter(String baseURI,
                       String userName,
                       String userPassword,
                       String generatorPrefix)

Method Detail

configFromProperties

public static HandleSystemRESTAdapter configFromProperties(Properties properties)
                                                    throws InvalidConfigException

Factory method. Generates a new instance from a properties instance.

Parameters:

properties -

Returns:

a new HandleSystemRESTAdapter instance

Throws:

InvalidConfigException

isIdentifierRegistered

public boolean isIdentifierRegistered(String pid)

Description copied from interface: IIdentifierSystem

Checks whether the given PID is already registered.

Specified by:

isIdentifierRegistered in interface IIdentifierSystem

Returns:

True or false

queryProperty

public String queryProperty(String pid,
                   PropertyDefinition propertyDefinition)
                     throws IOException

Description copied from interface: IIdentifierSystem

Queries a single property from the given PID.

Specified by:

queryProperty in interface IIdentifierSystem

Returns:

the property value or null if there is no property of given name defined in this PID record.

Throws:

IOException

generatePIDName

protected String generatePIDName()

registerPID

public String registerPID(Map<String,String> properties)
                   throws IOException

Description copied from interface: IIdentifierSystem

Registers a new PID with given property values. The method decides on a PID name automatically, guaranteeing its uniqueness and preventing failure due to potential overwrites.

Specified by:

registerPID in interface IIdentifierSystem

Parameters:

properties - A simple dictionary with string keys and string values that contains the initial PID record.

Returns:

the name of the registered PID

Throws:

IOException

queryByType

public PIDInformation queryByType(String pid,
                         TypeDefinition typeDefinition)
                           throws IOException

Description copied from interface: IIdentifierSystem

Queries all properties of a given type available from the given PID. If optional properties are present, they will be returned as well. If there are mandatory properties missing (i.e. the record of the given PID does not fully conform to the type), the method will NOT fail but simply return only those properties that are present.

Specified by:

queryByType in interface IIdentifierSystem

Returns:

a PID information record with property identifiers mapping to values. The property names will not be available (empty Strings). Contains all property values present in the record of the given PID that are also specified by the type (mandatory or optional). If the pid is not registered, the method returns null.

Throws:

IOException

deletePID

public boolean deletePID(String pid)

Description copied from interface: IIdentifierSystem

Remove the given PID. Obviously, this method is only for testing purposes, since we should not delete persistent identifiers...

Specified by:

deletePID in interface IIdentifierSystem

Returns:

true if the identifier was deleted, false if it did not exist

queryAllProperties

public PIDInformation queryAllProperties(String pid)
                                  throws IOException

Description copied from interface: IIdentifierSystem

Queries all properties from the given PID, independent of types.

Specified by:

queryAllProperties in interface IIdentifierSystem

Returns:

a PID information record with property identifiers mapping to values. The property names will be empty strings. Contains all property values present in the record of the given PID. If the pid is not registered, the method returns null.

Throws:

IOException

getGeneratorPrefix

public String getGeneratorPrefix()