org.dataone.client.impl.rest

Class HttpMNode

java.lang.Object

org.dataone.client.impl.rest.MultipartD1Node

org.dataone.client.impl.rest.MultipartMNode

org.dataone.client.impl.rest.HttpMNode

All Implemented Interfaces:

D1Node, MNode, MNCore, MNRead, MNAuthorization, MNStorage, MNReplication, MNQuery

public class HttpMNode
extends MultipartMNode
implements MNode

MultipartMNode represents a MemberNode, and exposes the services associated with a DataONE Member Node, allowing calling clients to call the services associated with the node. By necessity, behavior for null values differs slightly from the REST api. Except where noted, null values in method parameters will: 1. throw a NotFound or InvalidRequest exception if the parameter is mapped to the URL path segment 2. omit the url query parameter if the parameter is mapped to a URL query segment 3. throw an InvalidRequest exception if the parameter is mapped to the message body Session objects get passed to the underlying HttpMultipartRestClient class, but be passed to the httpClient request, as they are pulled from the underlying filesystem of the local machine. Java implementation of the following types: Types.OctectStream - java.io.InputStream unsignedlong - we use long to keep to a native type, although only half capacity of unsigned Types.DateTime - java.util.Date Various methods may set their own timeouts by use of Settings.Configuration properties or by calling setDefaultSoTimeout. Settings.Configuration properties override any value of the DefaultSoTimeout. Timeouts are always represented in milliseconds timeout properties recognized: D1Client.MNode.create.timeout D1Client.MNode.update.timeout D1Client.MNode.replicate.timeout D1Client.MNode.getReplica.timeout D1Client.D1Node.listObjects.timeout D1Client.D1Node.getLogRecords.timeout D1Client.D1Node.get.timeout D1Client.D1Node.getSystemMetadata.timeout

Author:

Rob Nahf

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log

Fields inherited from class org.dataone.client.impl.rest.MultipartD1Node

nodeType, restClient, session

Fields inherited from interface org.dataone.service.mn.tier1.v1.MNCore

SERVICE_VERSION

Constructor Summary

Constructors

Constructor and Description
HttpMNode(MultipartRestClient mrc, String nodeBaseServiceUrl) Construct a new client-side MultipartMNode (Member Node) object, passing in the base url of the member node for calling its services.
HttpMNode(MultipartRestClient mrc, String nodeBaseServiceUrl, Session session) Construct a new client-side MultipartMNode (Member Node) object, passing in the base url of the member node for calling its services, and the Session to use for connections to that node.
HttpMNode(String nodeBaseServiceUrl) Deprecated.
HttpMNode(String nodeBaseServiceUrl, Session session) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
Identifier	create(Identifier pid, InputStream object, SystemMetadata sysmeta) see DataONE API Reference
Identifier	create(Session session, Identifier pid, InputStream object, SystemMetadata sysmeta) see DataONE API Reference
InputStream	get(Identifier pid) Get the resource with the specified pid.
InputStream	get(Session session, Identifier pid) Get the resource with the specified pid.
Integer	getDefaultSoTimeout()
Log	getLogRecords() see DataONE API Reference
Log	getLogRecords(Date fromDate, Date toDate, Event event, String pidFilter, Integer start, Integer count) see DataONE API Reference
Log	getLogRecords(Session session) see DataONE API Reference
Log	getLogRecords(Session session, Date fromDate, Date toDate, Event event, String pidFilter, Integer start, Integer count) see DataONE API Reference
InputStream	getReplica(Identifier pid) see DataONE API Reference
InputStream	getReplica(Session session, Identifier pid) see DataONE API Reference
SystemMetadata	getSystemMetadata(Identifier pid) Get the system metadata from a resource with the specified guid.
SystemMetadata	getSystemMetadata(Session session, Identifier pid) Get the system metadata from a resource with the specified guid.
ObjectList	listObjects() see DataONE API Reference
ObjectList	listObjects(Date fromDate, Date toDate, ObjectFormatIdentifier formatid, Boolean replicaStatus, Integer start, Integer count) see DataONE API Reference
ObjectList	listObjects(Session session) see DataONE API Reference
ObjectList	listObjects(Session session, Date fromDate, Date toDate, ObjectFormatIdentifier formatid, Boolean replicaStatus, Integer start, Integer count) see DataONE API Reference
boolean	replicate(Session session, SystemMetadata sysmeta, NodeReference sourceNode) see DataONE API Reference
boolean	replicate(SystemMetadata sysmeta, NodeReference sourceNode) see DataONE API Reference
void	setDefaultSoTimeout(Integer defaultSoTimeout)
protected org.apache.http.client.config.RequestConfig	setTimeouts(Integer milliseconds)
Identifier	update(Identifier pid, InputStream object, Identifier newPid, SystemMetadata sysmeta) see DataONE API Reference
Identifier	update(Session session, Identifier pid, InputStream object, Identifier newPid, SystemMetadata sysmeta) see DataONE API Reference

Methods inherited from class org.dataone.client.impl.rest.MultipartMNode

archive, archive, delete, delete, describe, describe, generateIdentifier, generateIdentifier, getCapabilities, getChecksum, getChecksum, getNodeBaseServiceUrl, getQueryEngineDescription, isAuthorized, isAuthorized, listQueryEngines, ping, query, synchronizationFailed, synchronizationFailed, systemMetadataChanged, systemMetadataChanged

Methods inherited from class org.dataone.client.impl.rest.MultipartD1Node

deserializeServiceType, getLatestRequestUrl, getNodeId, getNodeType, getSystemMetadata, getSystemMetadata, localizeInputStream, query, setNodeBaseServiceUrl, setNodeId, setNodeType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dataone.client.D1Node

getLatestRequestUrl, getNodeBaseServiceUrl, getNodeId, getNodeType, setNodeId, setNodeType

Methods inherited from interface org.dataone.service.mn.tier1.v1.MNCore

getCapabilities, ping

Methods inherited from interface org.dataone.service.mn.tier1.v1.MNRead

describe, describe, getChecksum, getChecksum, synchronizationFailed, synchronizationFailed

Methods inherited from interface org.dataone.service.mn.tier2.v1.MNAuthorization

isAuthorized, isAuthorized, systemMetadataChanged, systemMetadataChanged

Methods inherited from interface org.dataone.service.mn.tier3.v1.MNStorage

archive, archive, delete, delete, generateIdentifier, generateIdentifier

Methods inherited from interface org.dataone.service.mn.v1.MNQuery

getQueryEngineDescription, listQueryEngines, query

Field Detail

log

protected static org.apache.commons.logging.Log log

Constructor Detail

HttpMNode

@Deprecated
public HttpMNode(String nodeBaseServiceUrl)

Deprecated.

Construct a new client-side MultipartMNode (Member Node) object, passing in the base url of the member node for calling its services.

Parameters:

nodeBaseServiceUrl - base url for constructing service endpoints.

HttpMNode

@Deprecated
public HttpMNode(String nodeBaseServiceUrl,
                    Session session)

Deprecated.

Construct a new client-side MultipartMNode (Member Node) object, passing in the base url of the member node for calling its services, and the Session to use for connections to that node.

Parameters:

nodeBaseServiceUrl - base url for constructing service endpoints.

session - - the Session object passed to the CertificateManager to be used for establishing connections

HttpMNode

public HttpMNode(MultipartRestClient mrc,
         String nodeBaseServiceUrl)

Construct a new client-side MultipartMNode (Member Node) object, passing in the base url of the member node for calling its services.

Parameters:

nodeBaseServiceUrl - base url for constructing service endpoints.

HttpMNode

public HttpMNode(MultipartRestClient mrc,
         String nodeBaseServiceUrl,
         Session session)

Construct a new client-side MultipartMNode (Member Node) object, passing in the base url of the member node for calling its services, and the Session to use for connections to that node.

Parameters:

nodeBaseServiceUrl - base url for constructing service endpoints.

session - - the Session object passed to the CertificateManager to be used for establishing connections

Method Detail

getLogRecords

public Log getLogRecords()
                  throws InvalidRequest,
                         InvalidToken,
                         NotAuthorized,
                         NotImplemented,
                         ServiceFailure

see DataONE API Reference

Overrides:

getLogRecords in class MultipartMNode

Throws:

InvalidRequest

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

getLogRecords

public Log getLogRecords(Session session)
                  throws InvalidRequest,
                         InvalidToken,
                         NotAuthorized,
                         NotImplemented,
                         ServiceFailure

see DataONE API Reference

Overrides:

getLogRecords in class MultipartMNode

Throws:

InvalidRequest

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

getLogRecords

public Log getLogRecords(Date fromDate,
                Date toDate,
                Event event,
                String pidFilter,
                Integer start,
                Integer count)
                  throws InvalidRequest,
                         InvalidToken,
                         NotAuthorized,
                         NotImplemented,
                         ServiceFailure

see DataONE API Reference

Specified by:

getLogRecords in interface MNCore

Overrides:

getLogRecords in class MultipartMNode

Throws:

InvalidRequest

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/MN_APIs.html#MN_core.getLogRecords

getLogRecords

public Log getLogRecords(Session session,
                Date fromDate,
                Date toDate,
                Event event,
                String pidFilter,
                Integer start,
                Integer count)
                  throws InvalidRequest,
                         InvalidToken,
                         NotAuthorized,
                         NotImplemented,
                         ServiceFailure

see DataONE API Reference

Specified by:

getLogRecords in interface MNCore

Overrides:

getLogRecords in class MultipartMNode

Throws:

InvalidRequest

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/MN_APIs.html#MN_core.getLogRecords

listObjects

public ObjectList listObjects()
                       throws InvalidRequest,
                              InvalidToken,
                              NotAuthorized,
                              NotImplemented,
                              ServiceFailure

see DataONE API Reference

Overrides:

listObjects in class MultipartMNode

Throws:

InvalidRequest

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

listObjects

public ObjectList listObjects(Session session)
                       throws InvalidRequest,
                              InvalidToken,
                              NotAuthorized,
                              NotImplemented,
                              ServiceFailure

see DataONE API Reference

Overrides:

listObjects in class MultipartMNode

Throws:

InvalidRequest

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

listObjects

public ObjectList listObjects(Date fromDate,
                     Date toDate,
                     ObjectFormatIdentifier formatid,
                     Boolean replicaStatus,
                     Integer start,
                     Integer count)
                       throws InvalidRequest,
                              InvalidToken,
                              NotAuthorized,
                              NotImplemented,
                              ServiceFailure

see DataONE API Reference

Specified by:

listObjects in interface MNRead

Overrides:

listObjects in class MultipartMNode

Throws:

InvalidRequest

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/MN_APIs.html#MN_read.listObjects

listObjects

public ObjectList listObjects(Session session,
                     Date fromDate,
                     Date toDate,
                     ObjectFormatIdentifier formatid,
                     Boolean replicaStatus,
                     Integer start,
                     Integer count)
                       throws InvalidRequest,
                              InvalidToken,
                              NotAuthorized,
                              NotImplemented,
                              ServiceFailure

see DataONE API Reference

Specified by:

listObjects in interface MNRead

Overrides:

listObjects in class MultipartMNode

Throws:

InvalidRequest

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/MN_APIs.html#MN_read.listObjects

get

public InputStream get(Identifier pid)
                throws InvalidToken,
                       NotAuthorized,
                       NotImplemented,
                       ServiceFailure,
                       NotFound,
                       InsufficientResources

Description copied from class: MultipartD1Node

Get the resource with the specified pid. Used by both the CNode and MultipartMNode subclasses. A LocalCache is used to cache objects in memory and in a local disk cache if the "D1Client.useLocalCache" configuration property was set to true when the MultipartD1Node was created. Otherwise InputStream is the Java native version of D1's OctetStream

Specified by:

get in interface MNRead

Overrides:

get in class MultipartMNode

Throws:

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

NotFound

InsufficientResources

See Also:

see DataONE API Reference (MemberNode API), see DataONE API Reference (CoordinatingNode API)

get

public InputStream get(Session session,
              Identifier pid)
                throws InvalidToken,
                       NotAuthorized,
                       NotImplemented,
                       ServiceFailure,
                       NotFound,
                       InsufficientResources

Description copied from class: MultipartD1Node

Get the resource with the specified pid. Used by both the CNode and MultipartMNode subclasses. A LocalCache is used to cache objects in memory and in a local disk cache if the "D1Client.useLocalCache" configuration property was set to true when the MultipartD1Node was created. Otherwise InputStream is the Java native version of D1's OctetStream

Specified by:

get in interface MNRead

Overrides:

get in class MultipartMNode

Throws:

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

NotFound

InsufficientResources

See Also:

see DataONE API Reference (MemberNode API), see DataONE API Reference (CoordinatingNode API)

getSystemMetadata

public SystemMetadata getSystemMetadata(Identifier pid)
                                 throws InvalidToken,
                                        NotAuthorized,
                                        NotImplemented,
                                        ServiceFailure,
                                        NotFound

Description copied from class: MultipartD1Node

Get the system metadata from a resource with the specified guid. Used by both the CNode and MultipartMNode implementations. Note that this method defaults to not using the local system metadata cache provided by the client, as SystemMetadata is mutable and so caching can lead to issues. In specific cases where a client wants to utilize the same system metadata in rapid succession, it may make sense to temporarily use the local cache by calling @see #getSystemMetadata(Session, Identifier, boolean).

Specified by:

getSystemMetadata in interface MNRead

Overrides:

getSystemMetadata in class MultipartMNode

Throws:

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

NotFound

See Also:

DataONE API Reference (MemberNode API), DataONE API Reference (CoordinatingNode API)

getSystemMetadata

public SystemMetadata getSystemMetadata(Session session,
                               Identifier pid)
                                 throws InvalidToken,
                                        NotAuthorized,
                                        NotImplemented,
                                        ServiceFailure,
                                        NotFound

Description copied from class: MultipartD1Node

Get the system metadata from a resource with the specified guid. Used by both the CNode and MultipartMNode implementations. Note that this method defaults to not using the local system metadata cache provided by the client, as SystemMetadata is mutable and so caching can lead to issues. In specific cases where a client wants to utilize the same system metadata in rapid succession, it may make sense to temporarily use the local cache by calling @see #getSystemMetadata(Session, Identifier, boolean).

Specified by:

getSystemMetadata in interface MNRead

Overrides:

getSystemMetadata in class MultipartMNode

Throws:

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

NotFound

See Also:

DataONE API Reference (MemberNode API), DataONE API Reference (CoordinatingNode API)

create

public Identifier create(Identifier pid,
                InputStream object,
                SystemMetadata sysmeta)
                  throws IdentifierNotUnique,
                         InsufficientResources,
                         InvalidRequest,
                         InvalidSystemMetadata,
                         InvalidToken,
                         NotAuthorized,
                         NotImplemented,
                         ServiceFailure,
                         UnsupportedType

see DataONE API Reference

Specified by:

create in interface MNStorage

Overrides:

create in class MultipartMNode

Throws:

IdentifierNotUnique

InsufficientResources

InvalidRequest

InvalidSystemMetadata

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

UnsupportedType

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/MN_APIs.html#MN_storage.create

create

public Identifier create(Session session,
                Identifier pid,
                InputStream object,
                SystemMetadata sysmeta)
                  throws IdentifierNotUnique,
                         InsufficientResources,
                         InvalidRequest,
                         InvalidSystemMetadata,
                         InvalidToken,
                         NotAuthorized,
                         NotImplemented,
                         ServiceFailure,
                         UnsupportedType

see DataONE API Reference

Specified by:

create in interface MNStorage

Overrides:

create in class MultipartMNode

Throws:

IdentifierNotUnique

InsufficientResources

InvalidRequest

InvalidSystemMetadata

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

UnsupportedType

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/MN_APIs.html#MN_storage.create

update

public Identifier update(Identifier pid,
                InputStream object,
                Identifier newPid,
                SystemMetadata sysmeta)
                  throws IdentifierNotUnique,
                         InsufficientResources,
                         InvalidRequest,
                         InvalidSystemMetadata,
                         InvalidToken,
                         NotAuthorized,
                         NotImplemented,
                         ServiceFailure,
                         UnsupportedType,
                         NotFound

see DataONE API Reference

Specified by:

update in interface MNStorage

Overrides:

update in class MultipartMNode

Throws:

IdentifierNotUnique

InsufficientResources

InvalidRequest

InvalidSystemMetadata

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

UnsupportedType

NotFound

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/MN_APIs.html#MN_storage.update

update

public Identifier update(Session session,
                Identifier pid,
                InputStream object,
                Identifier newPid,
                SystemMetadata sysmeta)
                  throws IdentifierNotUnique,
                         InsufficientResources,
                         InvalidRequest,
                         InvalidSystemMetadata,
                         InvalidToken,
                         NotAuthorized,
                         NotImplemented,
                         ServiceFailure,
                         UnsupportedType,
                         NotFound

see DataONE API Reference

Specified by:

update in interface MNStorage

Overrides:

update in class MultipartMNode

Throws:

IdentifierNotUnique

InsufficientResources

InvalidRequest

InvalidSystemMetadata

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

UnsupportedType

NotFound

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/MN_APIs.html#MN_storage.update

replicate

public boolean replicate(SystemMetadata sysmeta,
                NodeReference sourceNode)
                  throws NotImplemented,
                         ServiceFailure,
                         NotAuthorized,
                         InvalidRequest,
                         InvalidToken,
                         InsufficientResources,
                         UnsupportedType

see DataONE API Reference

Specified by:

replicate in interface MNReplication

Overrides:

replicate in class MultipartMNode

Throws:

NotImplemented

ServiceFailure

NotAuthorized

InvalidRequest

InvalidToken

InsufficientResources

UnsupportedType

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/MN_APIs.html#MN_replication.replicate

replicate

public boolean replicate(Session session,
                SystemMetadata sysmeta,
                NodeReference sourceNode)
                  throws NotImplemented,
                         ServiceFailure,
                         NotAuthorized,
                         InvalidRequest,
                         InvalidToken,
                         InsufficientResources,
                         UnsupportedType

see DataONE API Reference

Specified by:

replicate in interface MNReplication

Overrides:

replicate in class MultipartMNode

Throws:

NotImplemented

ServiceFailure

NotAuthorized

InvalidRequest

InvalidToken

InsufficientResources

UnsupportedType

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/MN_APIs.html#MN_replication.replicate

getReplica

public InputStream getReplica(Identifier pid)
                       throws InvalidToken,
                              NotAuthorized,
                              NotImplemented,
                              ServiceFailure,
                              NotFound,
                              InsufficientResources

see DataONE API Reference

Specified by:

getReplica in interface MNRead

Overrides:

getReplica in class MultipartMNode

Throws:

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

NotFound

InsufficientResources

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/MN_APIs.html#MNRead.getReplica

getReplica

public InputStream getReplica(Session session,
                     Identifier pid)
                       throws InvalidToken,
                              NotAuthorized,
                              NotImplemented,
                              ServiceFailure,
                              NotFound,
                              InsufficientResources

see DataONE API Reference

Specified by:

getReplica in interface MNRead

Overrides:

getReplica in class MultipartMNode

Throws:

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

NotFound

InsufficientResources

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/MN_APIs.html#MNRead.getReplica

setTimeouts

protected org.apache.http.client.config.RequestConfig setTimeouts(Integer milliseconds)

getDefaultSoTimeout

public Integer getDefaultSoTimeout()

setDefaultSoTimeout

public void setDefaultSoTimeout(Integer defaultSoTimeout)