MultipartMNode (DataONE Java Client Library 2.3.0 API)

java.lang.Object
- org.dataone.client.rest.MultipartD1Node
- - org.dataone.client.v2.impl.MultipartD1Node
  - - org.dataone.client.v2.impl.MultipartMNode

All Implemented Interfaces:

D1Node, MNode, MNCore, MNRead, MNAuthorization, MNStorage, MNReplication, MNPackage, MNQuery, MNView
```
public class MultipartMNode
extends MultipartD1Node
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 - 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.rest.MultipartD1Node
  defaultRestClient, defaultSession, latestRestClient, latestSession, nodeType
- Fields inherited from interface org.dataone.service.mn.tier1.v2.MNCore
  SERVICE_VERSION

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

Constructor Summary

Constructors
Constructor and Description
`MultipartMNode(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.
`MultipartMNode(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.
`MultipartMNode(String nodeBaseServiceUrl)` Deprecated.

Method Summary

Methods
Modifier and Type	Method and Description
`Identifier`	`archive(Identifier pid)`
`Identifier`	`archive(Session session, Identifier pid)` sets the archived flag to true on an MN or CN
`Identifier`	`create(Session session, Identifier pid, InputStream object, SystemMetadata sysmeta)`
`Identifier`	`delete(Identifier pid)`
`Identifier`	`delete(Session session, Identifier pid)`
`DescribeResponse`	`describe(Identifier pid)`
`DescribeResponse`	`describe(Session session, Identifier pid)`
`Identifier`	`generateIdentifier(Session session, String scheme, String fragment)`
`Identifier`	`generateIdentifier(String scheme, String fragment)`
`InputStream`	`get(Identifier pid)` Get the resource with the specified pid.
`InputStream`	`get(Session session, Identifier pid)` Get the resource with the specified pid.
`Node`	`getCapabilities()`
`Checksum`	`getChecksum(Identifier pid, String checksumAlgorithm)`
`Checksum`	`getChecksum(Session session, Identifier pid, String checksumAlgorithm)` This method can handle both the MN and CN method, although the CN overriding method will need to recast the InvalidRequest exception and use 'null' for the checksumAlgorithm param
`Log`	`getLogRecords(Session session, Date fromDate, Date toDate, String event, String idFilter, Integer start, Integer count)`
`String`	`getNodeBaseServiceUrl()` Retrieve the service URL for this node.
`InputStream`	`getPackage(Session session, ObjectFormatIdentifier packageType, Identifier id)`
`InputStream`	`getReplica(Session session, Identifier pid)`
`SystemMetadata`	`getSystemMetadata(Session session, Identifier id)` Get the system metadata from a resource with the specified guid, potentially using the local system metadata cache if specified to do so.
`boolean`	`isAuthorized(Identifier pid, Permission action)`
`boolean`	`isAuthorized(Session session, Identifier pid, Permission action)`
`ObjectList`	`listObjects(Session session, Date fromDate, Date toDate, ObjectFormatIdentifier formatid, Identifier identifier, Boolean replicaStatus, Integer start, Integer count)`
`OptionList`	`listViews(Session session)`
`Date`	`ping()`
`boolean`	`replicate(Session session, SystemMetadata sysmeta, NodeReference sourceNode)`
`boolean`	`synchronizationFailed(Session session, SynchronizationFailed message)`
`Identifier`	`update(Session session, Identifier pid, InputStream object, Identifier newPid, SystemMetadata sysmeta)`
`boolean`	`updateSystemMetadata(Session session, Identifier pid, SystemMetadata sysmeta)`
`InputStream`	`view(Session session, String theme, Identifier id)`

Methods inherited from class org.dataone.client.rest.MultipartD1Node
closeLoudly, deserializeServiceType, getLatestRequestUrl, getNodeId, getNodeType, getQueryEngineDescription, getRestClient, listQueryEngines, query, setNodeBaseServiceUrl, setNodeId, setNodeType, systemMetadataChanged

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, getNodeId, getNodeType, setNodeId, setNodeType

Methods inherited from interface org.dataone.service.mn.tier1.v2.MNRead
systemMetadataChanged

Methods inherited from interface org.dataone.service.mn.v2.MNQuery
getQueryEngineDescription, listQueryEngines, query

Field Detail

log

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

Constructor Detail
- MultipartMNode
```
@Deprecated
public MultipartMNode(String nodeBaseServiceUrl)
               throws IOException,
                      ClientSideException
```
  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.
  
  Throws:
  
  ClientSideException
  
  IOException
- MultipartMNode
```
public MultipartMNode(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.
- MultipartMNode
```
public MultipartMNode(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

getNodeBaseServiceUrl
```
public String getNodeBaseServiceUrl()
```
Description copied from class: MultipartD1Node

Retrieve the service URL for this node. The service URL can be used with knowledge of the DataONE REST API to construct endpoints for each of the DataONE REST services that are available on the node.

Specified by:

getNodeBaseServiceUrl in interface D1Node

Overrides:

getNodeBaseServiceUrl in class MultipartD1Node

Returns:
String representing the service URL

ping
```
public Date ping()
          throws NotImplemented,
                 ServiceFailure,
                 InsufficientResources
```
Specified by:

ping in interface MNCore

Overrides:

ping in class MultipartD1Node

Throws:

NotImplemented

ServiceFailure

InsufficientResources
See Also:
https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_core.ping

listObjects

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

Specified by:: listObjects in interface MNRead
Throws:: InvalidRequest; InvalidToken; NotAuthorized; NotImplemented; ServiceFailure
See Also:: https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_read.listObjects

getCapabilities
```
public Node getCapabilities()
                     throws NotImplemented,
                            ServiceFailure
```
Specified by:

getCapabilities in interface MNCore

Overrides:

getCapabilities in class MultipartD1Node

Throws:

NotImplemented

ServiceFailure
See Also:
https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_core.getCapabilities

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. InputStream is the Java native version of D1's OctetStream

Overrides:

get in class MultipartD1Node

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. InputStream is the Java native version of D1's OctetStream

Specified by:

get in interface MNRead

Overrides:

get in class MultipartD1Node

Throws:

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

NotFound

InsufficientResources
See Also:
see DataONE API Reference (MemberNode API), see DataONE API Reference (CoordinatingNode API)

getLogRecords

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

Specified by:: getLogRecords in interface MNCore
Throws:: InvalidToken; InvalidRequest; ServiceFailure; NotAuthorized; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_core.getLogRecords

getSystemMetadata
```
public SystemMetadata getSystemMetadata(Session session,
                               Identifier id)
                                 throws InvalidToken,
                                        ServiceFailure,
                                        NotAuthorized,
                                        NotFound,
                                        NotImplemented
```
Get the system metadata from a resource with the specified guid, potentially using the local system metadata cache if specified to do so. Used by both the CNode and MultipartMNode implementations. Because SystemMetadata is mutable, caching can lead to currency 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 setting useSystemMetadadataCache to true.

Specified by:

getSystemMetadata in interface MNRead

Overrides:

getSystemMetadata in class MultipartD1Node

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

NotImplemented
See Also:
DataONE API Reference (MemberNode API), DataONE API Reference (CoordinatingNode API)

describe

public DescribeResponse describe(Identifier pid)
                          throws InvalidToken,
                                 NotAuthorized,
                                 NotImplemented,
                                 ServiceFailure,
                                 NotFound

Overrides:: describe in class MultipartD1Node
Throws:: InvalidToken; NotAuthorized; NotImplemented; ServiceFailure; NotFound

describe

public DescribeResponse describe(Session session,
                        Identifier pid)
                          throws InvalidToken,
                                 NotAuthorized,
                                 NotImplemented,
                                 ServiceFailure,
                                 NotFound

Specified by:: describe in interface MNRead
Overrides:: describe in class MultipartD1Node
Throws:: InvalidToken; NotAuthorized; NotImplemented; ServiceFailure; NotFound
See Also:: https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_read.describe

getChecksum

public Checksum getChecksum(Identifier pid,
                   String checksumAlgorithm)
                     throws InvalidRequest,
                            InvalidToken,
                            NotAuthorized,
                            NotImplemented,
                            ServiceFailure,
                            NotFound

Overrides:: getChecksum in class MultipartD1Node
Throws:: InvalidRequest; InvalidToken; NotAuthorized; NotImplemented; ServiceFailure; NotFound

getChecksum

public Checksum getChecksum(Session session,
                   Identifier pid,
                   String checksumAlgorithm)
                     throws InvalidRequest,
                            InvalidToken,
                            NotAuthorized,
                            NotImplemented,
                            ServiceFailure,
                            NotFound

Description copied from class: MultipartD1Node

This method can handle both the MN and CN method, although the CN overriding method will need to recast the InvalidRequest exception and use 'null' for the checksumAlgorithm param

Specified by:: getChecksum in interface MNRead
Overrides:: getChecksum in class MultipartD1Node; checksumAlgorithm - - for MN implementations only
Throws:: InvalidRequest - - for MN implementations only; InvalidToken; NotAuthorized; NotImplemented; ServiceFailure; NotFound
See Also:: https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_read.getChecksum

synchronizationFailed

public boolean synchronizationFailed(Session session,
                            SynchronizationFailed message)
                              throws InvalidToken,
                                     NotAuthorized,
                                     NotImplemented,
                                     ServiceFailure

Specified by:: synchronizationFailed in interface MNRead
Throws:: InvalidToken; NotAuthorized; NotImplemented; ServiceFailure
See Also:: https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_read.synchronizationFailed

isAuthorized

public boolean isAuthorized(Identifier pid,
                   Permission action)
                     throws ServiceFailure,
                            InvalidRequest,
                            InvalidToken,
                            NotFound,
                            NotAuthorized,
                            NotImplemented

Overrides:: isAuthorized in class MultipartD1Node
Throws:: ServiceFailure; InvalidRequest; InvalidToken; NotFound; NotAuthorized; NotImplemented

isAuthorized

public boolean isAuthorized(Session session,
                   Identifier pid,
                   Permission action)
                     throws ServiceFailure,
                            InvalidRequest,
                            InvalidToken,
                            NotFound,
                            NotAuthorized,
                            NotImplemented

Specified by:: isAuthorized in interface MNAuthorization
Overrides:: isAuthorized in class MultipartD1Node
Throws:: ServiceFailure; InvalidRequest; InvalidToken; NotFound; NotAuthorized; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_auth.isAuthorized

generateIdentifier

public Identifier generateIdentifier(String scheme,
                            String fragment)
                              throws InvalidToken,
                                     ServiceFailure,
                                     NotAuthorized,
                                     NotImplemented,
                                     InvalidRequest

Overrides:: generateIdentifier in class MultipartD1Node
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotImplemented; InvalidRequest

generateIdentifier

public Identifier generateIdentifier(Session session,
                            String scheme,
                            String fragment)
                              throws InvalidToken,
                                     ServiceFailure,
                                     NotAuthorized,
                                     NotImplemented,
                                     InvalidRequest

Specified by:: generateIdentifier in interface MNStorage
Overrides:: generateIdentifier in class MultipartD1Node
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotImplemented; InvalidRequest
See Also:: https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MNStorage.generateIdentifier

create

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

Specified by:: create in interface MNStorage
Throws:: IdentifierNotUnique; InsufficientResources; InvalidRequest; InvalidSystemMetadata; InvalidToken; NotAuthorized; NotImplemented; ServiceFailure; UnsupportedType
See Also:: https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_storage.create

updateSystemMetadata

public boolean updateSystemMetadata(Session session,
                           Identifier pid,
                           SystemMetadata sysmeta)
                             throws NotImplemented,
                                    NotAuthorized,
                                    ServiceFailure,
                                    InvalidRequest,
                                    InvalidSystemMetadata,
                                    InvalidToken

Specified by:: updateSystemMetadata in interface MNStorage
Overrides:: updateSystemMetadata in class MultipartD1Node
Throws:: NotImplemented; NotAuthorized; ServiceFailure; InvalidRequest; InvalidSystemMetadata; InvalidToken
See Also:: https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_storage.updateSystemMetadata

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

Specified by:: update in interface MNStorage
Throws:: IdentifierNotUnique; InsufficientResources; InvalidRequest; InvalidSystemMetadata; InvalidToken; NotAuthorized; NotImplemented; ServiceFailure; UnsupportedType; NotFound
See Also:: https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_storage.update

delete

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

Overrides:: delete in class MultipartD1Node
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented

delete

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

Specified by:: delete in interface MNStorage
Overrides:: delete in class MultipartD1Node
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_storage.delete

replicate

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

Specified by:: replicate in interface MNReplication
Throws:: NotImplemented; ServiceFailure; NotAuthorized; InvalidRequest; InvalidToken; InsufficientResources; UnsupportedType
See Also:: https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_replication.replicate

getReplica

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

Specified by:: getReplica in interface MNRead
Throws:: InvalidToken; NotAuthorized; NotImplemented; ServiceFailure; NotFound; InsufficientResources
See Also:: https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MNRead.getReplica

view

public InputStream view(Session session,
               String theme,
               Identifier id)
                 throws InvalidToken,
                        ServiceFailure,
                        NotAuthorized,
                        InvalidRequest,
                        NotImplemented,
                        NotFound

Specified by:: view in interface MNView
Overrides:: view in class MultipartD1Node
Throws:: InvalidToken; ServiceFailure; NotAuthorized; InvalidRequest; NotImplemented; NotFound
See Also:: https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MNView.view

listViews

public OptionList listViews(Session session)
                     throws InvalidToken,
                            ServiceFailure,
                            NotAuthorized,
                            InvalidRequest,
                            NotImplemented

Specified by:: listViews in interface MNView
Overrides:: listViews in class MultipartD1Node
Throws:: InvalidToken; ServiceFailure; NotAuthorized; InvalidRequest; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MNView.listViews

getPackage

public InputStream getPackage(Session session,
                     ObjectFormatIdentifier packageType,
                     Identifier id)
                       throws InvalidToken,
                              ServiceFailure,
                              NotAuthorized,
                              InvalidRequest,
                              NotImplemented,
                              NotFound,
                              UnsupportedType

Specified by:: getPackage in interface MNPackage
Throws:: InvalidToken; ServiceFailure; NotAuthorized; InvalidRequest; NotImplemented; NotFound; UnsupportedType
See Also:: https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MNPackage.getPackage

Class MultipartMNode

Field Summary

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.dataone.client.D1Node

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

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

Field Detail

log

Constructor Detail

MultipartMNode

MultipartMNode

MultipartMNode

Method Detail

getNodeBaseServiceUrl

ping

listObjects

getCapabilities

get

get

getLogRecords

getSystemMetadata

describe

describe

getChecksum

getChecksum

synchronizationFailed

isAuthorized

isAuthorized

generateIdentifier

generateIdentifier

create

updateSystemMetadata

update

archive

archive

delete

delete

replicate

getReplica

view

listViews

getPackage