MultipartD1Node (DataONE Java Client Library 2.3.0 API)

java.lang.Object
- org.dataone.client.rest.MultipartD1Node

All Implemented Interfaces:

D1Node

Direct Known Subclasses:

MultipartCNode, MultipartD1Node, MultipartMNode
```
public abstract class MultipartD1Node
extends Object
implements D1Node
```
An abstract node class that contains base functionality shared between Coordinating Node and Member Node implementations. 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.D1Node.listObjects.timeout D1Client.D1Node.getLogRecords.timeout D1Client.D1Node.get.timeout D1Client.D1Node.getSystemMetadata.timeout

Field Summary

Fields
Modifier and Type	Field and Description
`protected MultipartRestClient`	`defaultRestClient` the D1Node instance adapter / connector to the RESTful service endpoints
`protected Session`	`defaultSession` this represents the defaultSession to be used for establishing the SSL connection
`protected MultipartRestClient`	`latestRestClient` the latest MRC used to make an API call
`protected Session`	`latestSession`
`protected static org.apache.commons.logging.Log`	`log`
`protected NodeType`	`nodeType`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`MultipartD1Node()` Deprecated.
	`MultipartD1Node(MultipartRestClient client, String nodeBaseServiceUrl)` Convenience constructor to create a new instance.
`protected`	`MultipartD1Node(MultipartRestClient client, String nodeBaseServiceUrl, Session session)` Users can set either a default RestClient or default Session that will build a RestClient configured appropriately from the information in the Session.
	`MultipartD1Node(Session session, String nodeBaseServiceUrl)` Convenience constructor to create a new instance.
	`MultipartD1Node(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
`protected static void`	`closeLoudly(InputStream is)` Utility method to be used in finally blocks for methods that have to close inputStreams.
`Identifier`	`delete(Identifier pid)`
`Identifier`	`delete(Session session, Identifier pid)`
`DescribeResponse`	`describe(Identifier pid)`
`DescribeResponse`	`describe(Session session, Identifier pid)`
`protected <T> T`	`deserializeServiceType(Class<T> domainClass, InputStream is)` deserialize an object of type from the inputstream This is a wrapper method of the standard common Unmarshalling method that recasts exceptions to ServiceFailure
`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.
`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
`String`	`getLatestRequestUrl()` Useful for debugging to see what the last call was
`String`	`getNodeBaseServiceUrl()` Retrieve the service URL for this node.
`NodeReference`	`getNodeId()` Get the NodeId associated with the D1Node
`NodeType`	`getNodeType()` Get the NodeType associated with the D1Node
`QueryEngineDescription`	`getQueryEngineDescription(Session session, String queryEngine)`
`protected MultipartRestClient`	`getRestClient(Session sessionFromMethod)` API methods should use this method to get the MultipartRestClient to be used for the call.
`boolean`	`isAuthorized(Identifier pid, Permission action)`
`boolean`	`isAuthorized(Session session, Identifier pid, Permission action)`
`QueryEngineList`	`listQueryEngines(Session session)`
`protected OptionList`	`listViews(Session session)`
`Date`	`ping()`
`InputStream`	`query(Session session, String queryEngine, String encodedQuery)` As with the sister query() method that takes a D1Url, the contents of encodedQuery will be joined to the url with as follows: /{queryEngine}/{encodedQuery} Note: Users will need to provide the '?' where appropriate to mark the beginning of the url-query portion.
`void`	`setNodeBaseServiceUrl(String nodeBaseServiceUrl)` Set the service URL for this node.
`void`	`setNodeId(NodeReference nodeId)` Set the NodeId associated with the D1Node
`void`	`setNodeType(NodeType nodeType)` Set the Nodetype for the D1Node
`boolean`	`systemMetadataChanged(Session session, Identifier pid, long serialVersion, Date dateSystemMetadataLastModified)`
`protected InputStream`	`view(Session session, String theme, Identifier id)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- log
```
protected static org.apache.commons.logging.Log log
```
- defaultRestClient
```
protected MultipartRestClient defaultRestClient
```
  the D1Node instance adapter / connector to the RESTful service endpoints
- latestRestClient
```
protected MultipartRestClient latestRestClient
```
  the latest MRC used to make an API call
- latestSession
```
protected Session latestSession
```
- defaultSession
```
protected Session defaultSession
```
  this represents the defaultSession to be used for establishing the SSL connection
- nodeType
```
protected NodeType nodeType
```

Constructor Detail
- MultipartD1Node
```
protected MultipartD1Node(MultipartRestClient client,
               String nodeBaseServiceUrl,
               Session session)
```
  Users can set either a default RestClient or default Session that will build a RestClient configured appropriately from the information in the Session.
- MultipartD1Node
```
public MultipartD1Node(MultipartRestClient client,
               String nodeBaseServiceUrl)
```
  Convenience constructor to create a new instance.
- MultipartD1Node
```
public MultipartD1Node(Session session,
               String nodeBaseServiceUrl)
```
  Convenience constructor to create a new instance.
- MultipartD1Node
```
@Deprecated
public MultipartD1Node(String nodeBaseServiceUrl)
                throws IOException,
                       ClientSideException
```
  Deprecated.
  
  Constructor to create a new instance.
  
  Throws:
  
  ClientSideException
  
  IOException
- MultipartD1Node
```
@Deprecated
public MultipartD1Node()
```
  Deprecated.
  
  default constructor needed by some clients. This constructor will probably go away so don't depend on it. Use public MultipartD1Node(String nodeBaseServiceUrl) instead.

Method Detail

closeLoudly
```
protected static void closeLoudly(InputStream is)
                           throws ServiceFailure
```
Utility method to be used in finally blocks for methods that have to close inputStreams. Contrast with IOUtils.closeQuietly(is). Closes the input stream, taking care of null situations, and throwing an appropriate DataONE exception if there is a problem with closing.

Parameters:
is -

Throws:

ServiceFailure - - thrown if is.close throws an IOException

getRestClient
```
protected MultipartRestClient getRestClient(Session sessionFromMethod)
                                     throws ServiceFailure
```
API methods should use this method to get the MultipartRestClient to be used for the call.

Parameters:
sessionFromMethod - - this should be the session from the API method parameter

Returns:

Throws:

ServiceFailure

getNodeBaseServiceUrl
```
public String getNodeBaseServiceUrl()
```
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

Returns:
String representing the service URL

setNodeBaseServiceUrl
```
public void setNodeBaseServiceUrl(String nodeBaseServiceUrl)
```
Set 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.

Parameters:
nodeBaseServiceUrl - String representing the service URL

getNodeId
```
public NodeReference getNodeId()
```
Description copied from interface: D1Node

Get the NodeId associated with the D1Node

Specified by:

getNodeId in interface D1Node

Returns:
the nodeId

setNodeId
```
public void setNodeId(NodeReference nodeId)
```
Description copied from interface: D1Node

Set the NodeId associated with the D1Node

Specified by:

setNodeId in interface D1Node

Parameters:
nodeId - the nodeId to set

setNodeType
```
public void setNodeType(NodeType nodeType)
```
Description copied from interface: D1Node

Set the Nodetype for the D1Node

Specified by:

setNodeType in interface D1Node

getNodeType
```
public NodeType getNodeType()
```
Description copied from interface: D1Node

Get the NodeType associated with the D1Node

Specified by:

getNodeType in interface D1Node

Returns:
NodeType

getLatestRequestUrl
```
public String getLatestRequestUrl()
```
Useful for debugging to see what the last call was

Specified by:

getLatestRequestUrl in interface D1Node

Returns:

ping

public Date ping()
          throws NotImplemented,
                 ServiceFailure,
                 InsufficientResources

Throws:: NotImplemented; ServiceFailure; InsufficientResources

get

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

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

Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented; 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,
                       ServiceFailure,
                       NotAuthorized,
                       NotFound,
                       NotImplemented,
                       InsufficientResources

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

Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented; InsufficientResources
See Also:: see DataONE API Reference (MemberNode API), see DataONE API Reference (CoordinatingNode API)

systemMetadataChanged

public boolean systemMetadataChanged(Session session,
                            Identifier pid,
                            long serialVersion,
                            Date dateSystemMetadataLastModified)
                              throws InvalidToken,
                                     ServiceFailure,
                                     NotAuthorized,
                                     NotImplemented,
                                     InvalidRequest

Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotImplemented; InvalidRequest

describe

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

Throws:: InvalidToken; NotAuthorized; NotImplemented; ServiceFailure; NotFound

describe

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

Throws:: InvalidToken; NotAuthorized; NotImplemented; ServiceFailure; NotFound

getChecksum

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

Throws:: InvalidRequest; InvalidToken; NotAuthorized; NotImplemented; ServiceFailure; NotFound

getChecksum

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

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

Parameters:: defaultSession -; pid -; checksumAlgorithm - - for MN implementations only
Returns:
Throws:: InvalidRequest - - for MN implementations only; InvalidToken; NotAuthorized; NotImplemented; ServiceFailure; NotFound

isAuthorized

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

Throws:: ServiceFailure; InvalidRequest; InvalidToken; NotFound; NotAuthorized; NotImplemented

isAuthorized

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

Throws:: ServiceFailure; InvalidRequest; InvalidToken; NotFound; NotAuthorized; NotImplemented

generateIdentifier

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

Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotImplemented; InvalidRequest

generateIdentifier

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

Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotImplemented; InvalidRequest

delete

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

Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented

delete

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

Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented

query
```
public InputStream query(Session session,
                String queryEngine,
                String encodedQuery)
                  throws InvalidToken,
                         ServiceFailure,
                         NotAuthorized,
                         InvalidRequest,
                         NotImplemented,
                         NotFound
```
As with the sister query() method that takes a D1Url, the contents of encodedQuery will be joined to the url with as follows: /{queryEngine}/{encodedQuery} Note: Users will need to provide the '?' where appropriate to mark the beginning of the url-query portion. (for example, solr queries are entirely contained in the query portion of a url, so users need the first character of the provided encodedQuery to be a '?')

Parameters:
queryEngine -
encodedQuery -

Returns:

Throws:

InvalidToken

ServiceFailure

NotAuthorized

InvalidRequest

NotImplemented

NotFound

getQueryEngineDescription

public QueryEngineDescription getQueryEngineDescription(Session session,
                                               String queryEngine)
                                                 throws InvalidToken,
                                                        ServiceFailure,
                                                        NotAuthorized,
                                                        NotImplemented,
                                                        NotFound

Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotImplemented; NotFound

listQueryEngines

public QueryEngineList listQueryEngines(Session session)
                                 throws InvalidToken,
                                        ServiceFailure,
                                        NotAuthorized,
                                        NotImplemented

Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotImplemented

deserializeServiceType
```
protected <T> T deserializeServiceType(Class<T> domainClass,
                           InputStream is)
                            throws ServiceFailure
```
deserialize an object of type from the inputstream This is a wrapper method of the standard common Unmarshalling method that recasts exceptions to ServiceFailure

Parameters:
type - the class of the object to serialize (i.e. SystemMetadata.class)
is - the stream to deserialize from

Throws:

ServiceFailure

view

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

Throws:: InvalidToken; ServiceFailure; NotAuthorized; InvalidRequest; NotImplemented; NotFound

listViews

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

Throws:: InvalidToken; ServiceFailure; NotAuthorized; InvalidRequest; NotImplemented

Class MultipartD1Node

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

defaultRestClient

latestRestClient

latestSession

defaultSession

nodeType

Constructor Detail

MultipartD1Node

MultipartD1Node

MultipartD1Node

MultipartD1Node

MultipartD1Node

Method Detail

closeLoudly

getRestClient

getNodeBaseServiceUrl

setNodeBaseServiceUrl

getNodeId

setNodeId

setNodeType

getNodeType

getLatestRequestUrl

ping

get

get

systemMetadataChanged

describe

describe

getChecksum

getChecksum

isAuthorized

isAuthorized

generateIdentifier

generateIdentifier

archive

archive

delete

delete

query

getQueryEngineDescription

listQueryEngines

deserializeServiceType

view

listViews