org.dataone.service.cn.impl.v1

Class ReserveIdentifierService

java.lang.Object

org.dataone.service.cn.impl.v1.ReserveIdentifierService

public class ReserveIdentifierService
extends Object

Class used for adding and managing reserved Identifiers Identifiers are housed in LDAP and replicated across CNs

Author:

leinfelder

Constructor Summary

Constructors

Constructor and Description
ReserveIdentifierService()

Method Summary

Methods

Modifier and Type	Method and Description
void	expireEntries(int numberOfDays)
org.dataone.service.types.v1.Identifier	generateIdentifier(org.dataone.service.types.v1.Session session, String scheme, String fragment) Generate a unique identifier and reserve it for use by Subject in the Session.
String	getAdmin()
String	getBase()
String	getPassword()
String	getServer()
boolean	hasReservation(org.dataone.service.types.v1.Session session, org.dataone.service.types.v1.Subject subject, org.dataone.service.types.v1.Identifier pid)
boolean	removeReservation(org.dataone.service.types.v1.Session session, org.dataone.service.types.v1.Identifier pid)
org.dataone.service.types.v1.Identifier	reserveIdentifier(org.dataone.service.types.v1.Session session, org.dataone.service.types.v1.Identifier pid) Reserves the given Identifier for the Subject in the Session Checks ownership of the pid by the subject if it already exists TODO: update created date in cases where we are "re-reserving"?
void	setAdmin(String admin)
void	setBase(String base)
void	setPassword(String password)
void	setServer(String server)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReserveIdentifierService

public ReserveIdentifierService()

Method Detail

getBase

public String getBase()

setBase

public void setBase(String base)

getServer

public String getServer()

setServer

public void setServer(String server)

getAdmin

public String getAdmin()

setAdmin

public void setAdmin(String admin)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

expireEntries

public void expireEntries(int numberOfDays)
                   throws NamingException

Throws:

NamingException

reserveIdentifier

public org.dataone.service.types.v1.Identifier reserveIdentifier(org.dataone.service.types.v1.Session session,
                                                        org.dataone.service.types.v1.Identifier pid)
                                                          throws org.dataone.service.exceptions.IdentifierNotUnique,
                                                                 org.dataone.service.exceptions.NotAuthorized,
                                                                 org.dataone.service.exceptions.ServiceFailure

Reserves the given Identifier for the Subject in the Session Checks ownership of the pid by the subject if it already exists TODO: update created date in cases where we are "re-reserving"?

Parameters:

session -

pid -

Returns:

Throws:

org.dataone.service.exceptions.IdentifierNotUnique

org.dataone.service.exceptions.NotAuthorized

org.dataone.service.exceptions.ServiceFailure

generateIdentifier

public org.dataone.service.types.v1.Identifier generateIdentifier(org.dataone.service.types.v1.Session session,
                                                         String scheme,
                                                         String fragment)
                                                           throws org.dataone.service.exceptions.InvalidRequest,
                                                                  org.dataone.service.exceptions.ServiceFailure,
                                                                  org.dataone.service.exceptions.NotAuthorized

Generate a unique identifier and reserve it for use by Subject in the Session. The identifier is generated according to the rules of the provided scheme, which must be a scheme which is support by the generateIdentifier service. Currently, the only supported scheme is "UUID" identifiers.

Parameters:

session - the Session identifying the caller

scheme - the name of the identifier scheme to be used in generating IDs

fragment - a string fragment that should be included in the identifier (optional)

Returns:

the Identifier that was generated

Throws:

org.dataone.service.exceptions.InvalidRequest - if the scheme is not supported, or no scheme is provided

org.dataone.service.exceptions.NotAuthorized

org.dataone.service.exceptions.ServiceFailure

removeReservation

public boolean removeReservation(org.dataone.service.types.v1.Session session,
                        org.dataone.service.types.v1.Identifier pid)
                          throws org.dataone.service.exceptions.InvalidToken,
                                 org.dataone.service.exceptions.ServiceFailure,
                                 org.dataone.service.exceptions.NotFound,
                                 org.dataone.service.exceptions.NotAuthorized,
                                 org.dataone.service.exceptions.NotImplemented,
                                 org.dataone.service.exceptions.InvalidRequest,
                                 org.dataone.service.exceptions.IdentifierNotUnique

Parameters:

session -

pid -

Returns:

Throws:

org.dataone.service.exceptions.NotAuthorized

org.dataone.service.exceptions.NotFound

org.dataone.service.exceptions.IdentifierNotUnique

org.dataone.service.exceptions.InvalidToken

org.dataone.service.exceptions.ServiceFailure

org.dataone.service.exceptions.NotImplemented

org.dataone.service.exceptions.InvalidRequest

hasReservation

public boolean hasReservation(org.dataone.service.types.v1.Session session,
                     org.dataone.service.types.v1.Subject subject,
                     org.dataone.service.types.v1.Identifier pid)
                       throws org.dataone.service.exceptions.InvalidToken,
                              org.dataone.service.exceptions.ServiceFailure,
                              org.dataone.service.exceptions.NotFound,
                              org.dataone.service.exceptions.NotAuthorized,
                              org.dataone.service.exceptions.NotImplemented,
                              org.dataone.service.exceptions.InvalidRequest

Throws:

org.dataone.service.exceptions.InvalidToken

org.dataone.service.exceptions.ServiceFailure

org.dataone.service.exceptions.NotFound

org.dataone.service.exceptions.NotAuthorized

org.dataone.service.exceptions.NotImplemented

org.dataone.service.exceptions.InvalidRequest