org.dataone.client.v1.itk

Class D1Client

java.lang.Object

org.dataone.client.v1.itk.D1Client

public class D1Client
extends Object

The D1Client class represents a client-side implementation of the DataONE Service API. The class exposes the DataONE APIs as client methods, dispatches the calls to the correct DataONE node, and then returns the results or throws the appropriate exceptions.

Field Summary

Fields

Modifier and Type	Field and Description
protected static MultipartRestClient	multipartRestClient

Constructor Summary

Constructors

Constructor and Description
D1Client()

Method Summary

Modifier and Type	Method and Description
static Identifier	archive(Session session, D1Object d1object) Perform an archive on an object in DataONE with the given D1Object on the authoritativeMemberNode contained in its systemMetadata.
static Identifier	create(Session session, D1Object d1object) Attempts to create the given D1Object on the originMemberNode contained in its SystemMetadata.
static CNode	getCN() Get the cached CNode object for calling Coordinating Node services.
static CNode	getCN(Session session) Deprecated. broken functionality, and unused. use getCN() or getCN(baseUrl) instead
static CNode	getCN(String cnBaseUrl) Returns a Coordinating Node using the base service URL to look up the node in the existing environment.
static MNode	getMN(NodeReference nodeRef) Return an MNode using the nodeReference for the member node.
static MNode	getMN(String mnBaseUrl) Returns a Member Node using the base service URL for the node.
protected static MultipartRestClient	getMultipartRestClient()
static ObsoletesChain	listUpdateHistory(Identifier pid) Return the full ObsoletesChain for the given Identifier.
static void	setCN(String cnUrl) Use this method to set the environment via the baseUrl to the environment's Coordinating Node.
static void	setNodeLocator(NodeLocator nodeLocator) For testing, we can override the nodeLocator
static Identifier	update(Session session, D1Object d1object) Perform an update an object in DataONE with the given D1Object on the originMemberNode contained in its systemMetadata.

Methods inherited from class java.lang.Object

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

Field Detail

multipartRestClient

protected static MultipartRestClient multipartRestClient

Constructor Detail

D1Client

public D1Client()

Method Detail

getMultipartRestClient

protected static MultipartRestClient getMultipartRestClient()
                                                     throws IOException,
                                                            ClientSideException

Throws:

IOException

ClientSideException

setNodeLocator

public static void setNodeLocator(NodeLocator nodeLocator)

For testing, we can override the nodeLocator

Parameters:

nodeLocator -

getCN

public static CNode getCN()
                   throws ServiceFailure,
                          NotImplemented

Get the cached CNode object for calling Coordinating Node services. By default returns the production context CN, defined via the property "D1Client.CN_URL". Use of D1Client in other contexts (non-production) requires overriding or changing this property name, or calling the setCN method. See org.dataone.configuration.Settings class for details. Connects using the default session / certificate

Returns:

the cn

Throws:

ServiceFailure

NotImplemented

getCN

@Deprecated
public static CNode getCN(Session session)
                               throws ServiceFailure,
                                      NotImplemented

Deprecated. broken functionality, and unused. use getCN() or getCN(baseUrl) instead

Get the cached CNode object for calling Coordinating Node services. By default returns the production context CN, defined via the property "D1Client.CN_URL". Use of D1Client in other contexts (non-production) requires overriding or changing this property name, or calling the setCN method See org.dataone.configuration.Settings class for details.

Parameters:

session - - the client session to be used in connections, null uses default behavior.

Returns:

the cn

Throws:

ServiceFailure

NotImplemented

setCN

public static void setCN(String cnUrl)
                  throws NotImplemented,
                         ServiceFailure

Use this method to set the environment via the baseUrl to the environment's Coordinating Node. Doing so affects future calls using the NodeReferences - only nodes registered in the context of the current CN will be findable by NodeReference.

Parameters:

cnUrl -

Throws:

NotImplemented

ServiceFailure

getMN

public static MNode getMN(String mnBaseUrl)
                   throws ServiceFailure

Returns a Member Node using the base service URL for the node.

Parameters:

mnBaseUrl - the service URL for the Member Node

Returns:

the mn at a particular URL

Throws:

ServiceFailure

getCN

public static CNode getCN(String cnBaseUrl)
                   throws ServiceFailure

Returns a Coordinating Node using the base service URL to look up the node in the existing environment.

Parameters:

cnBaseUrl -

Returns:

Throws:

ServiceFailure

getMN

public static MNode getMN(NodeReference nodeRef)
                   throws ServiceFailure

Return an MNode using the nodeReference for the member node.

Parameters:

nodeRef -

Returns:

Throws:

ServiceFailure

create

public static Identifier create(Session session,
                                D1Object d1object)
                         throws InvalidToken,
                                ServiceFailure,
                                NotAuthorized,
                                IdentifierNotUnique,
                                UnsupportedType,
                                InsufficientResources,
                                InvalidSystemMetadata,
                                NotImplemented,
                                InvalidRequest

Attempts to create the given D1Object on the originMemberNode contained in its SystemMetadata. Does not perform any identifier reservation checks or make any reservations.

Parameters:

session -

d1object - - the d1object representing both the data bytes and systemMetadata

Returns:

the Identifier returned from the mn.create call

Throws:

InvalidToken

ServiceFailure

NotAuthorized

IdentifierNotUnique

UnsupportedType

InsufficientResources

InvalidSystemMetadata

NotImplemented

InvalidRequest

update

public static Identifier update(Session session,
                                D1Object d1object)
                         throws InvalidToken,
                                ServiceFailure,
                                NotAuthorized,
                                IdentifierNotUnique,
                                UnsupportedType,
                                InsufficientResources,
                                InvalidSystemMetadata,
                                NotImplemented,
                                InvalidRequest,
                                NotFound

Perform an update an object in DataONE with the given D1Object on the originMemberNode contained in its systemMetadata. For this operation to work, the D1Object's systemMetadata needs have the obsoletes field set with the object to be updated, and the originMemberNode needs to match the authoritativeMemberNode of the object being updated. As with D1Client.create(), this method does not perform any identifier reservation checks or make any reservations.

Parameters:

session -

d1object - - the d1object representing both the data bytes and systemMetadata

Returns:

the Identifier returned from the mn.create call

Throws:

InvalidToken

ServiceFailure

NotAuthorized

IdentifierNotUnique

UnsupportedType

InsufficientResources

InvalidSystemMetadata

NotImplemented

InvalidRequest

NotFound

Since:

v1.2

archive

public static Identifier archive(Session session,
                                 D1Object d1object)
                          throws InvalidToken,
                                 ServiceFailure,
                                 NotAuthorized,
                                 NotFound,
                                 NotImplemented,
                                 InvalidRequest

Perform an archive on an object in DataONE with the given D1Object on the authoritativeMemberNode contained in its systemMetadata.

Parameters:

session -

d1object - - the d1object representing both the data bytes and systemMetadata

Returns:

the Identifier returned from the mn.archive call

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotImplemented

InvalidRequest

NotFound

ClientSideException

Since:

v1.2

listUpdateHistory

public static ObsoletesChain listUpdateHistory(Identifier pid)
                                        throws InvalidToken,
                                               ServiceFailure,
                                               NotAuthorized,
                                               NotFound,
                                               NotImplemented

Return the full ObsoletesChain for the given Identifier. Includes predecessors and antecedents.

Parameters:

pid -

Returns:

a complete ObsoletesChain

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

NotImplemented

ClientSideException

Since:

v1.2