A B C D E F G H I J L M N O P Q R S T U V X 

A

AccessPolicy - Class in org.dataone.service.types.v1
A set of rules that specifies as a whole the allowable permissions that a given user, group, or system has for accessing a resource, including data, metadata, resource map, and service resources.
AccessPolicy() - Constructor for class org.dataone.service.types.v1.AccessPolicy
 
AccessPolicyEditor - Class in org.dataone.client
 
AccessPolicyEditor(AccessPolicy) - Constructor for class org.dataone.client.AccessPolicyEditor
 
AccessRule - Class in org.dataone.service.types.v1
A rule that is used to allow a :term:`subject` to perform an action (such as read or write) on an object in DataONE.
AccessRule() - Constructor for class org.dataone.service.types.v1.AccessRule
 
AccessUtil - Class in org.dataone.service.types.v1.util
A helper class to simplify the use of AccessRules and AccessPolicies consisting of static factory methods for creating these nested objects (accessPolicy has accessRules has Permissions and Subjects, each subject has a value)
AccessUtil() - Constructor for class org.dataone.service.types.v1.util.AccessUtil
 
addAccess(Subject[], Permission) - Method in class org.dataone.client.AccessPolicyEditor
For the given Subjects, adds the permission specified unless the matching or a 'greater' permission is already there.
addAdditionalInfo(String) - Method in class org.dataone.service.types.v1_1.QueryEngineDescription
Add a 'additionalInfo' element item.
addAlgorithm(String) - Method in class org.dataone.service.types.v1.ChecksumAlgorithmList
Add a 'algorithm' element item.
addAllow(AccessRule) - Method in class org.dataone.service.types.v1.AccessPolicy
Add a 'allow' element item.
addAllowedNode(NodeReference) - Method in class org.dataone.service.types.v1.NodeReplicationPolicy
Add a 'allowedNode' element item.
addAllowedObjectFormat(ObjectFormatIdentifier) - Method in class org.dataone.service.types.v1.NodeReplicationPolicy
Add a 'allowedObjectFormat' element item.
addAndDownloadData(Identifier) - Method in class org.dataone.client.DataPackage
Puts an object with the given Identifier to the package's local, temporary data store.
addBlockedMemberNode(NodeReference) - Method in class org.dataone.service.types.v1.ReplicationPolicy
Add a 'blockedMemberNode' element item.
addContactSubject(Subject) - Method in class org.dataone.service.types.v1.Node
Add a 'contactSubject' element item.
addData(D1Object) - Method in class org.dataone.client.DataPackage
Puts a D1Object directly to the package's local, temporary data store without downloading it from a node.
addDateParamPair(String, Date) - Method in class org.dataone.service.util.D1Url
convenience method for adding date object to query parameters.
addDescription(String) - Method in class org.dataone.service.types.v1_1.QueryField
Add a 'description' element item.
addDistributionMetadata(String, String) - Method in class org.dataone.eml.EMLDocument
add a url and mime type to the document reference
addEmail(String) - Method in class org.dataone.service.types.v1.Person
Add a 'email' element item.
addEquivalentIdentity(Subject) - Method in class org.dataone.service.types.v1.Person
Add a 'equivalentIdentity' element item.
addFilePart(String, File) - Method in class org.dataone.mimemultipart.MultipartRequestHandler
Deprecated.
add a file part to the MMP
addFilePart(String, InputStream) - Method in class org.dataone.mimemultipart.MultipartRequestHandler
Deprecated.
add a file part to the MMP, using InputStream This method writes the contents of the stream to a temp file and sends it.
addFilePart(String, String) - Method in class org.dataone.mimemultipart.MultipartRequestHandler
Deprecated.
This method generates a temp files for sending, containing the value parameter.
addFilePart(String, File) - Method in class org.dataone.mimemultipart.SimpleMultipartEntity
add a file part to the MMP
addFilePart(String, InputStream) - Method in class org.dataone.mimemultipart.SimpleMultipartEntity
add a file part to the MMP, using InputStream This method writes the contents of the stream to a temp file and sends it.
addFilePart(String, Object) - Method in class org.dataone.mimemultipart.SimpleMultipartEntity
The DataONE object (serializable datatype) passed in is serialized as the specified type to file.
addFilePart(String, Object, Class) - Method in class org.dataone.mimemultipart.SimpleMultipartEntity
Deprecated.
addFilePart(String, String) - Method in class org.dataone.mimemultipart.SimpleMultipartEntity
This method generates a temp files for sending, containing the value parameter.
addGivenName(String) - Method in class org.dataone.service.types.v1.Person
Add a 'givenName' element item.
addGroup(Group) - Method in class org.dataone.service.types.v1.SubjectInfo
Add a 'group' element item.
addHasMember(Subject) - Method in class org.dataone.service.types.v1.Group
Add a 'hasMember' element item.
addIsMemberOf(Subject) - Method in class org.dataone.service.types.v1.Person
Add a 'isMemberOf' element item.
addLogEntry(LogEntry) - Method in class org.dataone.service.types.v1.Log
Add a 'logEntry' element item.
addMonitorInfo(MonitorInfo) - Method in class org.dataone.service.types.v1.MonitorList
Add a 'monitorInfo' element item.
addNextPathElement(String) - Method in class org.dataone.service.util.D1Url
adds the next path element to the path portion of the URL, encoding unsafe characters.
addNode(Node) - Method in class org.dataone.service.types.v1.NodeList
Add a 'node' element item.
addNonEmptyParam(String) - Method in class org.dataone.service.util.D1Url
adds a single parameter to the query portion of the URL (not a key-value pair) encoding unsafe characters.
addNonEmptyParamPair(String, String) - Method in class org.dataone.service.util.D1Url
adds a key value pair to the query portion of the URL, placing '=' character between them, and encoding unsafe characters.
addNonEmptyParamPair(String, Integer) - Method in class org.dataone.service.util.D1Url
adds a key value pair to the query portion of the URL, placing '=' character between them, and encoding unsafe characters.
addObject(Identifier, Date, Identifier, Identifier, Boolean) - Method in class org.dataone.client.types.ObsoletesChain
 
addObjectFormat(ObjectFormat) - Method in class org.dataone.service.types.v1.ObjectFormatList
Add a 'objectFormat' element item.
addObjectInfo(ObjectInfo) - Method in class org.dataone.service.types.v1.ObjectList
Add a 'objectInfo' element item.
addObjectLocation(ObjectLocation) - Method in class org.dataone.service.types.v1.ObjectLocationList
Add a 'objectLocation' element item.
addParamPart(String, String) - Method in class org.dataone.mimemultipart.MultipartRequestHandler
Deprecated.
add a param part to the MMP
addParamPart(String, String) - Method in class org.dataone.mimemultipart.SimpleMultipartEntity
add a param part to the MMP
addPermission(Permission) - Method in class org.dataone.service.types.v1.AccessRule
Add a 'permission' element item.
addPerson(Person) - Method in class org.dataone.service.types.v1.SubjectInfo
Add a 'person' element item.
addPreEncodedNonEmptyQueryParams(String) - Method in class org.dataone.service.util.D1Url
Method for adding query params that bypasses encoding.
addPreferredMemberNode(NodeReference) - Method in class org.dataone.service.types.v1.ReplicationPolicy
Add a 'preferredMemberNode' element item.
addPublicAccess(AccessPolicy) - Static method in class org.dataone.service.types.v1.util.AccessUtil
Given the original policy, return an AccessPolicy containing all of the original rules, plus a new rule allowing public read permission, if not already in place (otherwise returns the original).
addQueryEngine(String) - Method in class org.dataone.service.types.v1_1.QueryEngineList
Add a 'queryEngine' element item.
addQueryField(QueryField) - Method in class org.dataone.service.types.v1_1.QueryEngineDescription
Add a 'queryField' element item.
addReplica(Replica) - Method in class org.dataone.service.types.v1.SystemMetadata
Add a 'replica' element item.
addRestriction(ServiceMethodRestriction) - Method in class org.dataone.service.types.v1.Service
Add a 'restriction' element item.
addRightsHolder(Subject) - Method in class org.dataone.service.types.v1.Group
Add a 'rightsHolder' element item.
addService(Service) - Method in class org.dataone.service.types.v1.Services
Add a 'service' element item.
addSubject(Subject) - Method in class org.dataone.service.types.v1.AccessRule
Add a 'subject' element item.
addSubject(Subject) - Method in class org.dataone.service.types.v1.Node
Add a 'subject' element item.
addSubject(Subject) - Method in class org.dataone.service.types.v1.SubjectList
Add a 'subject' element item.
addTraceDetail(String, String) - Method in exception org.dataone.service.exceptions.BaseException
Add new detailed trace information, storing it the value under a known key.
addVersion(String) - Method in class org.dataone.service.types.v1.ObjectLocation
Add a 'version' element item.
archive(Identifier) - Method in class org.dataone.client.CNode
archive(Session, Identifier) - Method in class org.dataone.client.CNode
archive(Session, D1Object) - Static method in class org.dataone.client.D1Client
Perform an archive on an object in DataONE with the given D1Object on the authoritativeMemberNode contained in its systemMetadata.
archive(Identifier) - Method in class org.dataone.client.D1Node
 
archive(Session, Identifier) - Method in class org.dataone.client.D1Node
sets the archived flag to true on an MN or CN
archive(Identifier) - Method in class org.dataone.client.MNode
archive(Session, Identifier) - Method in class org.dataone.client.MNode
archive(Identifier) - Method in interface org.dataone.service.cn.v1.CNCore
 
archive(Session, Identifier) - Method in interface org.dataone.service.cn.v1.CNCore
Deprecated.
archive(Identifier) - Method in interface org.dataone.service.mn.tier3.v1.MNStorage
 
archive(Session, Identifier) - Method in interface org.dataone.service.mn.tier3.v1.MNStorage
Deprecated.
areChecksumsEqual(Checksum, Checksum) - Static method in class org.dataone.service.types.v1.util.ChecksumUtil
Returns true if and only if checksum1 and checksum2 are equal: Values are equal, algorithms are equal.
assembleUrl() - Method in class org.dataone.service.util.D1Url
 
augmentConfiguration(String) - Static method in class org.dataone.configuration.Settings
Include additional properties in the global configuration.
AuthenticationTimeout - Exception in org.dataone.service.exceptions
The DataONE AuthenticationTimeout exception, raised when authentication operations exceed pre-established limits.
AuthenticationTimeout(String, String) - Constructor for exception org.dataone.service.exceptions.AuthenticationTimeout
 
AuthenticationTimeout(String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.AuthenticationTimeout
 
AuthenticationTimeout(String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.AuthenticationTimeout
 
AuthenticationTimeout(String, String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.AuthenticationTimeout
 
authorizedClientSubjects(Session) - Static method in class org.dataone.service.types.v1.util.AuthUtils
Derived from Metacat implementation Creates a set of subjects represented in the session object, parsing both the subject of the session and the subjectInfo.
AuthUtils - Class in org.dataone.service.types.v1.util
 
AuthUtils() - Constructor for class org.dataone.service.types.v1.util.AuthUtils
 

B

BaseException - Exception in org.dataone.service.exceptions
A BaseException is the root of all DataONE service class exception messages.
BaseException(int, String, String) - Constructor for exception org.dataone.service.exceptions.BaseException
Construct a BaseException with the given code, detail code, and description.
BaseException(int, String, String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.BaseException
Construct a BaseException with the given code, detail code, pid, nodeId, description, and trace_information.
BaseException(int, String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.BaseException
Construct a BaseException with the given code, detail code, description, and trace_information.
BaseException(int, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.BaseException
Construct a BaseException with the given code, detail code, description, and trace_information.
BigIntegerMarshaller - Class in org.dataone.service.util
 
BigIntegerMarshaller() - Constructor for class org.dataone.service.util.BigIntegerMarshaller
 
buildAccessPolicy(HashMap<Subject, Set<Permission>>) - Static method in class org.dataone.service.types.v1.util.AccessUtil
creates an AccessPolicy instance where each contained AccessRule consists of one subject and that subject's permissions.
buildAccessRule(String, Permission) - Static method in class org.dataone.client.D1TypeBuilder
 
buildAccessRule(String, Permission[]) - Static method in class org.dataone.client.D1TypeBuilder
 
buildFormatIdentifier(String) - Static method in class org.dataone.client.D1TypeBuilder
 
buildIdentifier(String) - Static method in class org.dataone.client.D1TypeBuilder
 
buildMinimalSystemMetadata(Identifier, InputStream, ObjectFormatIdentifier, Subject) - Static method in class org.dataone.client.D1TypeBuilder
Builds a minimal and 'typical' SystemMetadata object containing all of the required fields needed for submission to DataONE at time of create.
buildNodeReference(String) - Static method in class org.dataone.client.D1TypeBuilder
 
buildSubject(String) - Static method in class org.dataone.client.D1TypeBuilder
Validates the identifier checking for any invalid characters The only rule currently is no whitespace.

C

CertificateManager - Class in org.dataone.client.auth
Import and manage certificates to be used for authentication against DataONE service providers.
CertificateManager() - Constructor for class org.dataone.client.auth.CertificateManager
CertificateManager is normally a singleton, but custom instances can be created if needed.
checkDataIntegrity() - Method in class org.dataone.client.D1Object
Compares the data to the values in the size and checksum SystemMetadata fields and returns true if they match.
checkLength(List<String>) - Static method in class org.dataone.client.D1Object
Check that the all strings in the array have > 0 length.
checkNotNull(List<Object>) - Static method in class org.dataone.client.D1Object
Check if any in a list of objects are null references.
Checksum - Class in org.dataone.service.types.v1
Represents the value of a computed :term:`checksum` expressed as a hexadecimal formatted version of the message digest.
Checksum() - Constructor for class org.dataone.service.types.v1.Checksum
 
checksum(InputStream, String) - Static method in class org.dataone.service.types.v1.util.ChecksumUtil
return a Checksum based on the input of the stream A useful technique when creating systemMetadata is to wrap the the inputStream in an org.apache.commons.io.input.CountingInputStream, to get the length of the content from the stream (after calling this method).
checksum(byte[], String) - Static method in class org.dataone.service.types.v1.util.ChecksumUtil
produce a checksum for the given byte array
ChecksumAlgorithmList - Class in org.dataone.service.types.v1
Represents a list of :term:`checksum` algorithms.
ChecksumAlgorithmList() - Constructor for class org.dataone.service.types.v1.ChecksumAlgorithmList
 
ChecksumUtil - Class in org.dataone.service.types.v1.util
 
ChecksumUtil() - Constructor for class org.dataone.service.types.v1.util.ChecksumUtil
 
cleanupTempFiles() - Method in class org.dataone.mimemultipart.MultipartRequestHandler
Deprecated.
calling this method attempts to delete the client-side temp files from the system.
cleanupTempFiles() - Method in class org.dataone.mimemultipart.SimpleMultipartEntity
calling this method attempts to delete the client-side temp files from the system.
clearAccessPolicy() - Method in class org.dataone.client.AccessPolicyEditor
 
clearAddedHeaders() - Method in class org.dataone.client.RestClient
clears the map of added headers
clearAdditionalInfoList() - Method in class org.dataone.service.types.v1_1.QueryEngineDescription
Remove all 'additionalInfo' element items.
clearAlgorithmList() - Method in class org.dataone.service.types.v1.ChecksumAlgorithmList
Remove all 'algorithm' element items.
clearAllowedNodeList() - Method in class org.dataone.service.types.v1.NodeReplicationPolicy
Remove all 'allowedNode' element items.
clearAllowedObjectFormatList() - Method in class org.dataone.service.types.v1.NodeReplicationPolicy
Remove all 'allowedObjectFormat' element items.
clearAllowList() - Method in class org.dataone.service.types.v1.AccessPolicy
Remove all 'allow' element items.
clearBlockedMemberNodeList() - Method in class org.dataone.service.types.v1.ReplicationPolicy
Remove all 'blockedMemberNode' element items.
clearContactSubjectList() - Method in class org.dataone.service.types.v1.Node
Remove all 'contactSubject' element items.
clearDescriptionList() - Method in class org.dataone.service.types.v1_1.QueryField
Remove all 'description' element items.
clearEmailList() - Method in class org.dataone.service.types.v1.Person
Remove all 'email' element items.
clearEquivalentIdentityList() - Method in class org.dataone.service.types.v1.Person
Remove all 'equivalentIdentity' element items.
clearGivenNameList() - Method in class org.dataone.service.types.v1.Person
Remove all 'givenName' element items.
clearGroupList() - Method in class org.dataone.service.types.v1.SubjectInfo
Remove all 'group' element items.
clearHasMemberList() - Method in class org.dataone.service.types.v1.Group
Remove all 'hasMember' element items.
clearIsMemberOfList() - Method in class org.dataone.service.types.v1.Person
Remove all 'isMemberOf' element items.
clearLogEntryList() - Method in class org.dataone.service.types.v1.Log
Remove all 'logEntry' element items.
clearMonitorInfoList() - Method in class org.dataone.service.types.v1.MonitorList
Remove all 'monitorInfo' element items.
clearNodeList() - Method in class org.dataone.service.types.v1.NodeList
Remove all 'node' element items.
clearObjectFormatList() - Method in class org.dataone.service.types.v1.ObjectFormatList
Remove all 'objectFormat' element items.
clearObjectInfoList() - Method in class org.dataone.service.types.v1.ObjectList
Remove all 'objectInfo' element items.
clearObjectLocationList() - Method in class org.dataone.service.types.v1.ObjectLocationList
Remove all 'objectLocation' element items.
clearPermissionList() - Method in class org.dataone.service.types.v1.AccessRule
Remove all 'permission' element items.
clearPersonList() - Method in class org.dataone.service.types.v1.SubjectInfo
Remove all 'person' element items.
clearPreferredMemberNodeList() - Method in class org.dataone.service.types.v1.ReplicationPolicy
Remove all 'preferredMemberNode' element items.
clearQueryEngineList() - Method in class org.dataone.service.types.v1_1.QueryEngineList
Remove all 'queryEngine' element items.
clearQueryFieldList() - Method in class org.dataone.service.types.v1_1.QueryEngineDescription
Remove all 'queryField' element items.
clearReplicaList() - Method in class org.dataone.service.types.v1.SystemMetadata
Remove all 'replica' element items.
clearRestrictionList() - Method in class org.dataone.service.types.v1.Service
Remove all 'restriction' element items.
clearRightsHolderList() - Method in class org.dataone.service.types.v1.Group
Remove all 'rightsHolder' element items.
clearServiceList() - Method in class org.dataone.service.types.v1.Services
Remove all 'service' element items.
clearSubjectList() - Method in class org.dataone.service.types.v1.AccessRule
Remove all 'subject' element items.
clearSubjectList() - Method in class org.dataone.service.types.v1.Node
Remove all 'subject' element items.
clearSubjectList() - Method in class org.dataone.service.types.v1.SubjectList
Remove all 'subject' element items.
clearVersionList() - Method in class org.dataone.service.types.v1.ObjectLocation
Remove all 'version' element items.
ClientIdentityManager - Class in org.dataone.client.auth
A client specific class to wrap certain CertificateManager methods, provide some introspection on the current client identity, as well as methods to manipulate identities.
ClientIdentityManager() - Constructor for class org.dataone.client.auth.ClientIdentityManager
 
clone() - Method in class org.dataone.client.AccessPolicyEditor
 
cloneAccessPolicy(AccessPolicy) - Static method in class org.dataone.service.types.v1.util.AccessUtil
 
cloneAccessRule(AccessRule) - Static method in class org.dataone.service.types.v1.util.AccessUtil
 
cloneChecksum(Checksum) - Static method in class org.dataone.client.D1TypeBuilder
 
cloneFormatIdentifier(ObjectFormatIdentifier) - Static method in class org.dataone.client.D1TypeBuilder
 
cloneIdentifier(Identifier) - Static method in class org.dataone.client.D1TypeBuilder
 
cloneNodeReference(NodeReference) - Static method in class org.dataone.client.D1TypeBuilder
 
cloneSubject(Subject) - Static method in class org.dataone.client.D1TypeBuilder
 
cloneSystemMetadata(SystemMetadata) - Static method in class org.dataone.client.D1TypeBuilder
Returns a clone of the given systemMetadata.
closeIdleConnections() - Method in class org.dataone.client.D1RestClient
Calls closeIdleConnections on the underlying connection manager.
CNAuthorization - Interface in org.dataone.service.cn.v1
The DataONE CoordinatingNode Tier2 Authorization interface.
CNCore - Interface in org.dataone.service.cn.v1
The DataONE CoordinatingNode Tier1 Core interface.
CNIdentity - Interface in org.dataone.service.cn.v1
The DataONE CoordinatingNode Tier2 Identity interface.
CNode - Class in org.dataone.client
CNode represents a DataONE Coordinating Node, and allows calling classes to execute CN services.
CNode(String) - Constructor for class org.dataone.client.CNode
Construct a Coordinating Node, passing in the base url for node services.
CNode(String, Session) - Constructor for class org.dataone.client.CNode
Construct a Coordinating Node, passing in the base url for node services, and the Session to use for connections to that node.
CNRead - Interface in org.dataone.service.cn.v1
The DataONE CoordinatingNode Tier1 Read interface.
CNRegister - Interface in org.dataone.service.cn.v1
The DataONE CoordinatingNode Tier2 Registration interface.
CNReplication - Interface in org.dataone.service.cn.v1
The DataONE CoordinatingNode Tier4 Replication interface.
compare(Object, Object) - Method in class org.dataone.service.types.v1.comparators.GroupNameComparator
Compares order based on the String groupName of two Group objects.
compare(Object, Object) - Method in class org.dataone.service.types.v1.comparators.PersonFamilyNameComparator
Compares order based on the String familyNames of two Person object.
compare(Object, Object) - Method in class org.dataone.service.types.v1.comparators.SysMetaModificationDateComparator
Compares the order based on the modified date of the two SystemMetadata objects.
compare(Object, Object) - Method in class org.dataone.service.types.v1.comparators.SysMetaUploadDateComparator
Compares the order based on the uploaded date of the two SystemMetadata objects.
compareD1ServiceType(Map<String, Object>, Boolean) - Static method in class org.dataone.service.types.TypeCompareUtil
This method will compare any number of dataone service-type objects of the same type to each other and return a report of every field where there is a difference.
comparePermissions(Permission, Collection<Permission>) - Static method in class org.dataone.service.types.v1.util.AuthUtils
a comparison algorithm for hierarchical permissions (WRITE implies READ, and CHANGE implies WRITE and READ).
compareSystemMetadata(SystemMetadata, SystemMetadata) - Static method in class org.dataone.service.types.TypeCompareUtil
Reports the properties of a systemMetadata object, one per line in xpath fashion.
compareTo(Object) - Method in class org.dataone.service.types.v1.Identifier
Compares order based on the String value of two objects of the same type.
compareTo(Object) - Method in class org.dataone.service.types.v1.NodeReference
Compares order based on the String value of two objects of the same type.
compareTo(Object) - Method in class org.dataone.service.types.v1.ObjectFormatIdentifier
Compares order based on the String value of two objects of the same type.
compareTo(Object) - Method in class org.dataone.service.types.v1.Subject
Compares order based on the String value of two objects of the same type.
confirmMapIdentity(Subject) - Method in class org.dataone.client.CNode
confirmMapIdentity(Session, Subject) - Method in class org.dataone.client.CNode
confirmMapIdentity(Subject) - Method in interface org.dataone.service.cn.v1.CNIdentity
 
confirmMapIdentity(Session, Subject) - Method in interface org.dataone.service.cn.v1.CNIdentity
Deprecated.
Constants - Class in org.dataone.service.util
 
Constants() - Constructor for class org.dataone.service.util.Constants
 
contains(Identifier) - Method in class org.dataone.client.DataPackage
Determine if an object with the given Identifier is already present in the local data store.
convert(String) - Static method in enum org.dataone.service.types.v1.Event
 
convert(String) - Static method in enum org.dataone.service.types.v1.NodeState
 
convert(String) - Static method in enum org.dataone.service.types.v1.NodeType
 
convert(String) - Static method in enum org.dataone.service.types.v1.Permission
 
convert(String) - Static method in enum org.dataone.service.types.v1.ReplicationStatus
 
copyDataPackages(CNode, MNode, List<Identifier>) - Method in class org.dataone.client.examples.ExampleDataPackageUpload
Copy oreIdentifers from sourceCn to targetMN.
create(Identifier, InputStream, SystemMetadata) - Method in class org.dataone.client.CNode
create(Session, Identifier, InputStream, SystemMetadata) - Method in class org.dataone.client.CNode
create(Session, D1Object) - Static method in class org.dataone.client.D1Client
Attempts to create the given D1Object on the originMemberNode contained in its SystemMetadata.
create(Identifier, InputStream, SystemMetadata) - Method in class org.dataone.client.MNode
create(Session, Identifier, InputStream, SystemMetadata) - Method in class org.dataone.client.MNode
create(Identifier, InputStream, SystemMetadata) - Method in interface org.dataone.service.cn.v1.CNCore
 
create(Session, Identifier, InputStream, SystemMetadata) - Method in interface org.dataone.service.cn.v1.CNCore
Deprecated.
create(Identifier, InputStream, SystemMetadata) - Method in interface org.dataone.service.mn.tier3.v1.MNStorage
 
create(Session, Identifier, InputStream, SystemMetadata) - Method in interface org.dataone.service.mn.tier3.v1.MNStorage
Deprecated.
createAccessRule(Subject[], Permission[]) - Static method in class org.dataone.service.types.v1.util.AccessUtil
creates an AccessRule containing the items specified in the parameters.
createAccessRule(String[], Permission[]) - Static method in class org.dataone.service.types.v1.util.AccessUtil
creates an AccessRule containing the items specified in the parameters.
createGroup(Group) - Method in class org.dataone.client.CNode
createGroup(Session, Group) - Method in class org.dataone.client.CNode
createGroup(Group) - Method in interface org.dataone.service.cn.v1.CNIdentity
 
createGroup(Session, Group) - Method in interface org.dataone.service.cn.v1.CNIdentity
Deprecated.
createReadWriteChangePermissionList() - Static method in class org.dataone.service.types.v1.util.AccessUtil
Dead-simple convenience method for creating a standard permission set of Read and Write and ChangePermission
createReadWriteChangePermissions() - Static method in class org.dataone.service.types.v1.util.AccessUtil
Dead-simple convenience method for creating a standard permission set of Read and Write and ChangePermission
createReadWritePermissionList() - Static method in class org.dataone.service.types.v1.util.AccessUtil
Dead-simple convenience method for creating a standard permission set of Read and Write.
createReadWritePermissions() - Static method in class org.dataone.service.types.v1.util.AccessUtil
Dead-simple convenience method for creating a standard permission set of Read and Write.
createResourceMap(Identifier, Map<Identifier, List<Identifier>>) - Method in class org.dataone.ore.ResourceMapFactory
creates a ResourceMap from the DataPackage representation.
createSingleRuleAccessPolicy(String[], Permission[]) - Static method in class org.dataone.service.types.v1.util.AccessUtil
creates an AccessPolicy with a single AccessRule, and the AccessRule composed of Subjects and Permissions specified in the parameters.
createSubjectList(String[]) - Static method in class org.dataone.service.types.v1.util.AccessUtil
creates a java-List of Subject objects from the given String array.

D

D1Client - Class in org.dataone.client
The D1Client class represents a client-side implementation of the DataONE Service API.
D1Client() - Constructor for class org.dataone.client.D1Client
 
D1Node - Class in org.dataone.client
An abstract node class that contains base functionality shared between Coordinating Node and Member Node implementations.
D1Node(String, Session) - Constructor for class org.dataone.client.D1Node
Constructor to create a new instance.
D1Node(String) - Constructor for class org.dataone.client.D1Node
Constructor to create a new instance.
D1Node() - Constructor for class org.dataone.client.D1Node
Deprecated.
D1Object - Class in org.dataone.client
A representation of an object that can be stored in the DataONE system.
D1Object() - Constructor for class org.dataone.client.D1Object
Construct a new D1Object, which is then populated with data and system metadata during the download process.
D1Object(Identifier, byte[], String, String, String) - Constructor for class org.dataone.client.D1Object
Deprecated.
D1Object(Identifier, byte[], ObjectFormatIdentifier, Subject, NodeReference) - Constructor for class org.dataone.client.D1Object
Deprecated.
D1Object(Identifier, DataSource, ObjectFormatIdentifier, Subject, NodeReference) - Constructor for class org.dataone.client.D1Object
Create an object that contains the given data bytes and with the given system metadata values.
D1RestClient - Class in org.dataone.client
This class wraps the RestClient, adding uniform exception deserialization and the setup of SSL for standard DataONE communications.
D1RestClient() - Constructor for class org.dataone.client.D1RestClient
Default constructor to create a new instance.
D1RestClient(AbstractHttpClient) - Constructor for class org.dataone.client.D1RestClient
 
D1RestClient(Session) - Constructor for class org.dataone.client.D1RestClient
Constructor to create a new instance with given session/subject.
D1RestClient(AbstractHttpClient, Session) - Constructor for class org.dataone.client.D1RestClient
 
D1TypeBuilder - Class in org.dataone.client
 
D1TypeBuilder() - Constructor for class org.dataone.client.D1TypeBuilder
 
D1Url - Class in org.dataone.service.util
 
D1Url(String, String) - Constructor for class org.dataone.service.util.D1Url
 
D1Url(String) - Constructor for class org.dataone.service.util.D1Url
 
D1Url() - Constructor for class org.dataone.service.util.D1Url
 
DataoneEMLParser - Class in org.dataone.eml
 
DataPackage - Class in org.dataone.client
A DataPackage is a collection of interrelated data (science data, metadata) D1Objects plus their defined relationships (the ResourceMap object) DataPackage allows all of the science metadata, data objects, and system metadata associated with those objects to be accessed from a common place.
DataPackage() - Constructor for class org.dataone.client.DataPackage
Default constructor without identifier.
DataPackage(Identifier) - Constructor for class org.dataone.client.DataPackage
Construct a DataPackage using the given identifier to identify this package.
DateTimeMarshaller - Class in org.dataone.service.util
 
DateTimeMarshaller() - Constructor for class org.dataone.service.util.DateTimeMarshaller
 
decodeString(String) - Static method in class org.dataone.service.util.EncodingUtilities
Decode and return the specified pct-encoded String.
decodeXmlDataItems(String) - Static method in class org.dataone.service.util.EncodingUtilities
 
delete(Identifier) - Method in class org.dataone.client.CNode
 
delete(Session, Identifier) - Method in class org.dataone.client.CNode
 
delete(Identifier) - Method in class org.dataone.client.D1Node
 
delete(Session, Identifier) - Method in class org.dataone.client.D1Node
 
delete(Identifier) - Method in class org.dataone.client.MNode
delete(Session, Identifier) - Method in class org.dataone.client.MNode
delete(Identifier) - Method in interface org.dataone.service.cn.v1.CNCore
 
delete(Session, Identifier) - Method in interface org.dataone.service.cn.v1.CNCore
Deprecated.
delete(Identifier) - Method in interface org.dataone.service.mn.tier3.v1.MNStorage
 
delete(Session, Identifier) - Method in interface org.dataone.service.mn.tier3.v1.MNStorage
Deprecated.
DELETE - Static variable in class org.dataone.service.util.Constants
HTTP Verb DELETE
deleteReplicationMetadata(Identifier, NodeReference, long) - Method in class org.dataone.client.CNode
deleteReplicationMetadata(Session, Identifier, NodeReference, long) - Method in class org.dataone.client.CNode
deleteReplicationMetadata(Identifier, NodeReference, long) - Method in interface org.dataone.service.cn.v1.CNReplication
 
deleteReplicationMetadata(Session, Identifier, NodeReference, long) - Method in interface org.dataone.service.cn.v1.CNReplication
Deprecated.
denyMapIdentity(Subject) - Method in class org.dataone.client.CNode
denyMapIdentity(Session, Subject) - Method in class org.dataone.client.CNode
denyMapIdentity(Subject) - Method in interface org.dataone.service.cn.v1.CNIdentity
 
denyMapIdentity(Session, Subject) - Method in interface org.dataone.service.cn.v1.CNIdentity
Deprecated.
describe(Identifier) - Method in class org.dataone.client.CNode
describe(Session, Identifier) - Method in class org.dataone.client.CNode
describe(Identifier) - Method in class org.dataone.client.D1Node
 
describe(Session, Identifier) - Method in class org.dataone.client.D1Node
 
describe(Identifier) - Method in class org.dataone.client.MNode
describe(Session, Identifier) - Method in class org.dataone.client.MNode
describe(Identifier) - Method in interface org.dataone.service.cn.v1.CNRead
 
describe(Session, Identifier) - Method in interface org.dataone.service.cn.v1.CNRead
Deprecated.
describe(Identifier) - Method in interface org.dataone.service.mn.tier1.v1.MNRead
 
describe(Session, Identifier) - Method in interface org.dataone.service.mn.tier1.v1.MNRead
Deprecated.
DescribeResponse - Class in org.dataone.service.types.v1
The DataONE Type to represent the metadata returned from a 'describe' request.
DescribeResponse(ObjectFormatIdentifier, BigInteger, Date, Checksum, BigInteger) - Constructor for class org.dataone.service.types.v1.DescribeResponse
instantiate a DescribeResponse object
deserializeAndThrowException(HttpResponse) - Static method in class org.dataone.service.util.ExceptionHandler
 
deserializeAndThrowException(InputStream, String, Integer, String) - Static method in class org.dataone.service.util.ExceptionHandler
Throw the exception that is contained in an HTTP response A response from an HTTP call may be determined to have an error.
deserializeBigInteger(String) - Static method in class org.dataone.service.util.BigIntegerMarshaller
convert a String to a BigInteger The String must be greater or equal to 0
deserializeDateToUTC(String) - Static method in class org.dataone.service.util.DateTimeMarshaller
convert a String to GMT date The STring must either be ISO 8601 compliant or http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.3.1 compliant
deserializeHeadersAndThrowException(int, Header[]) - Static method in class org.dataone.service.util.ExceptionHandler
 
deserializePackage(String) - Static method in class org.dataone.client.DataPackage
Deserialize an ORE resourceMap by parsing it, extracting the associated package identifier, and the list of metadata and data objects aggregated in the ORE Map.
deserializeResourceMap(InputStream) - Method in class org.dataone.ore.ResourceMapFactory
Deserialize the inputStream into a ResourceMap using the standard OREParserFactory settings.
deserializeResourceMap(InputStream, boolean) - Method in class org.dataone.ore.ResourceMapFactory
Deserialize the inputStream into a ResourceMap either literally (only asserted statements present), or including inferred statements.
deserializeServiceType(Class<T>, InputStream) - Method in class org.dataone.client.D1Node
deserialize an object of type from the inputstream This is a wrapper method of the standard common Unmarshalling method that recasts exceptions to ServiceFailure
deserializeServiceType(Class<T>, InputStream) - Static method in class org.dataone.service.util.ExceptionHandler
Wrapper for Marshalling method that recasts exceptions to ServiceFailure;
deserializeXml(InputStream, String) - Static method in class org.dataone.service.util.ExceptionHandler
 
displayCertificate(X509Certificate) - Method in class org.dataone.client.auth.CertificateManager
Show details of an X509 certificate, printing the information to STDOUT.
distributionMetadata - Variable in class org.dataone.eml.EMLDocument
 
doDeleteRequest(String) - Method in class org.dataone.client.D1RestClient
 
doDeleteRequest(String) - Method in class org.dataone.client.RestClient
send a Delete request to the resource and get the response
doGetRequest(String) - Method in class org.dataone.client.D1RestClient
Perform an HTTP GET request, setting the headers first and parsing /filtering exceptions to the exception stream on the response into their respective java instances.
doGetRequest(String, boolean) - Method in class org.dataone.client.D1RestClient
 
doGetRequest(String) - Method in class org.dataone.client.RestClient
send a GET request to the resource and get the response
doGetRequestForHeaders(String) - Method in class org.dataone.client.D1RestClient
 
doHeadRequest(String) - Method in class org.dataone.client.D1RestClient
 
doHeadRequest(String) - Method in class org.dataone.client.RestClient
send a Head request to the resource and get the response
doPostRequest(String, SimpleMultipartEntity) - Method in class org.dataone.client.D1RestClient
 
doPostRequest(String, SimpleMultipartEntity) - Method in class org.dataone.client.RestClient
send a POST request to the resource and get the response
doPutRequest(String, SimpleMultipartEntity) - Method in class org.dataone.client.D1RestClient
 
doPutRequest(String, SimpleMultipartEntity) - Method in class org.dataone.client.RestClient
send a PUT request to the resource and get the response
download(Identifier) - Static method in class org.dataone.client.D1Object
Contact D1 services to download the systemMetadata and data.
download(Identifier) - Static method in class org.dataone.client.DataPackage
Download the resource map

E

EMLDocument - Class in org.dataone.eml
 
EMLDocument() - Constructor for class org.dataone.eml.EMLDocument
constructor
EMLDocument.DistributionMetadata - Class in org.dataone.eml
sub class to contain the distribution metadata
EMLDocument.DistributionMetadata(String, String) - Constructor for class org.dataone.eml.EMLDocument.DistributionMetadata
 
EMLDocument.DistributionMetadata() - Constructor for class org.dataone.eml.EMLDocument.DistributionMetadata
 
encodeUrlFragment(String) - Static method in class org.dataone.service.util.EncodingUtilities
Encode the URL fragment section following RFC 3986.
encodeUrlPathSegment(String) - Static method in class org.dataone.service.util.EncodingUtilities
Encode a URL path segment as required by the URL specifications ( RFC 3986 and RFC 1738 section 3.3).
encodeUrlQuerySegment(String) - Static method in class org.dataone.service.util.EncodingUtilities
Encode a URL query segment following the item-list / key-value convention: query = "?" q-item *( "&" q-item) q=item = q-segment [ "=" q-segment ]
EncodingUtilities - Class in org.dataone.service.util
 
EncodingUtilities() - Constructor for class org.dataone.service.util.EncodingUtilities
 
equals(Object) - Method in class org.dataone.service.types.v1.comparators.GroupNameComparator
Indicates whether some other object is "equal to" this comparator.
equals(Object) - Method in class org.dataone.service.types.v1.comparators.PersonFamilyNameComparator
Indicates whether some other object is "equal to" this comparator.
equals(Object) - Method in class org.dataone.service.types.v1.comparators.SysMetaModificationDateComparator
Indicates whether some other object is "equal to" this comparator.
equals(Object) - Method in class org.dataone.service.types.v1.comparators.SysMetaUploadDateComparator
Indicates whether some other object is "equal to" this comparator.
equals(Object) - Method in class org.dataone.service.types.v1.Identifier
1 value 2 Value 3 String 4 (java.lang.String) 5 Identifier value is a string, override equals of Identifier.
equals(Object) - Method in class org.dataone.service.types.v1.NodeReference
1 value 2 Value 3 String 4 (java.lang.String) 5 NodeReference value is a string, override equals of NodeReference.
equals(Object) - Method in class org.dataone.service.types.v1.ObjectFormatIdentifier
1 value 2 Value 3 String 4 (java.lang.String) 5 ObjectFormatIdentifier value is a string, override equals of ObjectFormatIdentifier.
equals(Object) - Method in class org.dataone.service.types.v1.Subject
Value is a string, override equals of Subject.
equalsDN(String, String) - Method in class org.dataone.client.auth.CertificateManager
Compare Subject DNs for equality
Event - Enum in org.dataone.service.types.v1
The controlled list of events that are logged, which will include *create*, *update*, *delete*, *read*, *replicate*, synchronization_failed* and *replication_failed* events.
ExampleClient - Class in org.dataone.client.examples
ExampleClient is a command-line class that can be run to illustrate usage patterns of the d1_libclient_java library methods and services.
ExampleClient() - Constructor for class org.dataone.client.examples.ExampleClient
 
ExampleDataPackageUpload - Class in org.dataone.client.examples
Utility for uploading data packages to a MN.
ExampleDataPackageUpload() - Constructor for class org.dataone.client.examples.ExampleDataPackageUpload
 
ExceptionalInputStream - Class in org.dataone.service.util
This is a special purpose subclass of PushbackInputStream useful for determining whether or not an input stream contains a Dataone type, a Dataone exception, or other.
ExceptionalInputStream(InputStream) - Constructor for class org.dataone.service.util.ExceptionalInputStream
 
ExceptionHandler - Class in org.dataone.service.util
uniform deserialization of DataONE Exceptions that may be rethrown
ExceptionHandler() - Constructor for class org.dataone.service.util.ExceptionHandler
 
executeRequest() - Method in class org.dataone.mimemultipart.MultipartRequestHandler
Deprecated.
execute the request

F

filterErrors(HttpResponse) - Static method in class org.dataone.service.util.ExceptionHandler
 
filterErrors(HttpResponse, boolean) - Static method in class org.dataone.service.util.ExceptionHandler
 
filterErrors(InputStream, boolean, String) - Static method in class org.dataone.service.util.ExceptionHandler
 
filterErrorsHeader(HttpResponse, String) - Static method in class org.dataone.service.util.ExceptionHandler
will filter serialized errors coming from the HEAD request by deserializing them and putting on the exception thread(?).
findNode(NodeList, NodeReference) - Static method in class org.dataone.service.types.v1.util.NodelistUtil
Returns the first node with identifier of the provided node reference
findPersonsSubjects(Set<Subject>, SubjectInfo, Subject) - Static method in class org.dataone.service.types.v1.util.AuthUtils
A recursive method to traverse the equivalent-identity relationships and to handle the transitive nature of group membership and verified status.
FMT_HTML - Static variable in exception org.dataone.service.exceptions.BaseException
 
FMT_JSON - Static variable in exception org.dataone.service.exceptions.BaseException
 
FMT_XML - Static variable in exception org.dataone.service.exceptions.BaseException
 
format - Variable in class org.dataone.eml.EMLDocument
 

G

generateIdentifier(String, String) - Method in class org.dataone.client.CNode
generateIdentifier(Session, String, String) - Method in class org.dataone.client.CNode
generateIdentifier(String, String) - Method in class org.dataone.client.D1Node
 
generateIdentifier(Session, String, String) - Method in class org.dataone.client.D1Node
 
generateIdentifier(String, String) - Method in class org.dataone.client.MNode
generateIdentifier(Session, String, String) - Method in class org.dataone.client.MNode
generateIdentifier(String, String) - Method in interface org.dataone.service.cn.v1.CNCore
 
generateIdentifier(Session, String, String) - Method in interface org.dataone.service.cn.v1.CNCore
Deprecated.
generateIdentifier(String, String) - Method in interface org.dataone.service.mn.tier3.v1.MNStorage
 
generateIdentifier(Session, String, String) - Method in interface org.dataone.service.mn.tier3.v1.MNStorage
Deprecated.
get(Identifier) - Method in class org.dataone.client.CNode
 
get(Session, Identifier) - Method in class org.dataone.client.CNode
 
get(Identifier) - Method in class org.dataone.client.D1Node
Get the resource with the specified pid.
get(Session, Identifier) - Method in class org.dataone.client.D1Node
Get the resource with the specified pid.
get(Identifier) - Method in class org.dataone.client.DataPackage
Get the D1Object associated with a given Identifier from the local data store.
get(Identifier) - Method in class org.dataone.client.MNode
 
get(Session, Identifier) - Method in class org.dataone.client.MNode
 
get(Identifier) - Method in interface org.dataone.service.cn.v1.CNRead
InputStream is the Java native version of D1's OctetStream
get(Session, Identifier) - Method in interface org.dataone.service.cn.v1.CNRead
Deprecated.
get(Identifier) - Method in interface org.dataone.service.mn.tier1.v1.MNRead
InputStream is the Java native version of D1's OctetStream
get(Session, Identifier) - Method in interface org.dataone.service.mn.tier1.v1.MNRead
Deprecated.
GET - Static variable in class org.dataone.service.util.Constants
HTTP Verb GET
getAccessPolicy() - Method in class org.dataone.client.AccessPolicyEditor
gets the AccessPolicy being manipulated
getAccessPolicy() - Method in class org.dataone.service.types.v1.SystemMetadata
Get the 'accessPolicy' element value.
getAccessPolicyEditor() - Method in class org.dataone.client.D1Object
Provides an object to manipulate this D1Object's accessPolicy
getAddedHeaders() - Method in class org.dataone.client.D1RestClient
 
getAddedHeaders() - Method in class org.dataone.client.RestClient
returns a Map of the headers added via setHeader(..)
getAdditionalInfo(int) - Method in class org.dataone.service.types.v1_1.QueryEngineDescription
Get 'additionalInfo' element item by position.
getAdditionalInfoList() - Method in class org.dataone.service.types.v1_1.QueryEngineDescription
Get the list of 'additionalInfo' element items.
getAlgorithm() - Method in class org.dataone.service.types.v1.Checksum
Get the 'algorithm' attribute value.
getAlgorithm(int) - Method in class org.dataone.service.types.v1.ChecksumAlgorithmList
Get 'algorithm' element item by position.
getAlgorithmList() - Method in class org.dataone.service.types.v1.ChecksumAlgorithmList
Get the list of 'algorithm' element items.
getAllow(int) - Method in class org.dataone.service.types.v1.AccessPolicy
Get 'allow' element item by position.
getAllowedNode(int) - Method in class org.dataone.service.types.v1.NodeReplicationPolicy
Get 'allowedNode' element item by position.
getAllowedNodeList() - Method in class org.dataone.service.types.v1.NodeReplicationPolicy
Get the list of 'allowedNode' element items.
getAllowedObjectFormat(int) - Method in class org.dataone.service.types.v1.NodeReplicationPolicy
Get 'allowedObjectFormat' element item by position.
getAllowedObjectFormatList() - Method in class org.dataone.service.types.v1.NodeReplicationPolicy
Get the list of 'allowedObjectFormat' element items.
getAllowList() - Method in class org.dataone.service.types.v1.AccessPolicy
Get the list of 'allow' element items.
getArchived() - Method in class org.dataone.service.types.v1.SystemMetadata
Get the 'archived' element value.
getAssembledQueryString() - Method in class org.dataone.service.util.D1Url
 
getAttribute(String) - Method in class org.dataone.mimemultipart.MultipartRequest
 
getAttributeNames() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getAuthoritativeMemberNode() - Method in class org.dataone.service.types.v1.SystemMetadata
Get the 'authoritativeMemberNode' element value.
getAuthType() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getAvailable() - Method in class org.dataone.service.types.v1.Service
Get the 'available' attribute value.
getBaseURL() - Method in class org.dataone.service.types.v1.Node
Get the 'baseURL' element value.
getBaseURL() - Method in class org.dataone.service.types.v1.ObjectLocation
Get the 'baseURL' element value.
getBaseUrl() - Method in class org.dataone.service.util.D1Url
 
getBlockedMemberNode(int) - Method in class org.dataone.service.types.v1.ReplicationPolicy
Get 'blockedMemberNode' element item by position.
getBlockedMemberNodeList() - Method in class org.dataone.service.types.v1.ReplicationPolicy
Get the list of 'blockedMemberNode' element items.
getByPosition(int) - Method in class org.dataone.client.types.ObsoletesChain
 
getCACert(String) - Method in class org.dataone.client.auth.CertificateManager
Find the supplemental CA certificate to be used to validate user (peer) <
getCapabilities() - Method in class org.dataone.client.MNode
getCapabilities() - Method in interface org.dataone.service.mn.tier1.v1.MNCore
 
getCertificate(HttpServletRequest) - Method in class org.dataone.client.auth.CertificateManager
Get the client certificate from the request object
getCertificateExpiration() - Static method in class org.dataone.client.auth.ClientIdentityManager
 
getCertificateLocation() - Method in class org.dataone.client.auth.CertificateManager
 
getCharacterEncoding() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getChecksum(Identifier) - Method in class org.dataone.client.CNode
getChecksum(Session, Identifier) - Method in class org.dataone.client.CNode
getChecksum(Identifier, String) - Method in class org.dataone.client.D1Node
 
getChecksum(Session, Identifier, String) - Method in class org.dataone.client.D1Node
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
getChecksum(Identifier, String) - Method in class org.dataone.client.MNode
getChecksum(Session, Identifier, String) - Method in class org.dataone.client.MNode
getChecksum(Identifier) - Method in interface org.dataone.service.cn.v1.CNRead
 
getChecksum(Session, Identifier) - Method in interface org.dataone.service.cn.v1.CNRead
Deprecated.
getChecksum(Identifier, String) - Method in interface org.dataone.service.mn.tier1.v1.MNRead
 
getChecksum(Session, Identifier, String) - Method in interface org.dataone.service.mn.tier1.v1.MNRead
Deprecated.
getChecksum() - Method in class org.dataone.service.types.v1.ObjectInfo
Get the 'checksum' element value.
getChecksum() - Method in class org.dataone.service.types.v1.SystemMetadata
Get the 'checksum' element value.
getCN(Session) - Static method in class org.dataone.client.D1Client
Get the client instance of the Coordinating Node object for calling Coordinating Node services.
getCN() - Static method in class org.dataone.client.D1Client
Get the client instance of the Coordinating Node object for calling Coordinating Node services.
getCnAdministrativeList(List<Node>, String, String) - Static method in class org.dataone.service.types.v1.util.ServiceMethodRestrictionUtil
Returns an array of subjects listed as CN's in the nodelist or in a properties file.
getCode() - Method in exception org.dataone.service.exceptions.BaseException
 
getConfiguration() - Static method in class org.dataone.configuration.Settings
Get a Configuration interface that combines all resources found under all of the org.dataone.configuration/config.xml files from all application packages.
getContactSubject(int) - Method in class org.dataone.service.types.v1.Node
Get 'contactSubject' element item by position.
getContactSubjectList() - Method in class org.dataone.service.types.v1.Node
Get the list of 'contactSubject' element items.
getContent_Length() - Method in class org.dataone.service.types.v1.DescribeResponse
get the Size of the object in bytes, the value of SystemMetadata.size from SystemMetadata.
getContentLength() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getContentType() - Method in class org.dataone.client.InputStreamDataSource
get the content type of this stream
getContentType() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getContextPath() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getCookies() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getCount() - Method in class org.dataone.service.types.v1.MonitorInfo
Get the 'count' element value.
getCount() - Method in class org.dataone.service.types.v1.Slice
Get the 'count' attribute value.
getCurrentIdentity() - Static method in class org.dataone.client.auth.ClientIdentityManager
a simple encapsulation to return the client's (current) identity from the CertificateManager as a dataone Subject
getCurrentSession() - Static method in class org.dataone.client.auth.ClientIdentityManager
a simple encapsulation to return a session object built from the CertificateManager
getD1SubtypesListing(Object) - Static method in class org.dataone.service.types.TypeCompareUtil
A recursive method that returns a map of key value pairs that correspond to the property paths (keys) and values of the object passed in.
getD1SubtypesListing(String, Object, boolean) - Static method in class org.dataone.service.types.TypeCompareUtil
A recursive method that returns a map of key value pairs that correspond to the property paths (keys) and values of the object passed in.
getD1SubtypesListing(String, Object, boolean, boolean) - Static method in class org.dataone.service.types.TypeCompareUtil
 
getData(Identifier) - Method in class org.dataone.client.cache.LocalCache
Retrieve an array of bytes from the cache, throwing NotCached if the object with the Identifier key is not in the cache.
getData() - Method in class org.dataone.client.D1Object
Deprecated. 
getDataONE_Checksum() - Method in class org.dataone.service.types.v1.DescribeResponse
get The algorithm (SystemMetadata.algorithm) and Checksum (SystemMetadata.checksum) of the object being examined, drawn from the SystemMetadata.
getDataONE_ObjectFormatIdentifier() - Method in class org.dataone.service.types.v1.DescribeResponse
get The value of the SystemMetadata.objectFormatIdentifier entry available in the SystemMetadata.
getDataSource() - Method in class org.dataone.client.D1Object
get the DataSource representing the data
getDate() - Method in class org.dataone.service.types.v1.MonitorInfo
Get the 'date' element value.
getDateHeader(String) - Method in class org.dataone.mimemultipart.MultipartRequest
 
getDateLogged() - Method in class org.dataone.service.types.v1.LogEntry
Get the 'dateLogged' element value.
getDateSysMetadataModified() - Method in class org.dataone.service.types.v1.ObjectInfo
Get the 'dateSysMetadataModified' element value.
getDateSysMetadataModified() - Method in class org.dataone.service.types.v1.SystemMetadata
Get the 'dateSysMetadataModified' element value.
getDateUploaded() - Method in class org.dataone.service.types.v1.SystemMetadata
Get the 'dateUploaded' element value.
getDefaultSoTimeout() - Method in class org.dataone.client.D1Node
 
getDescription() - Method in class org.dataone.mimemultipart.SimpleMultipartEntity
Returns a concise description of the existing file parts, as comma-separated key-value pairs.
getDescription() - Method in exception org.dataone.service.exceptions.BaseException
 
getDescription() - Method in class org.dataone.service.types.v1.Node
Get the 'description' element value.
getDescription(int) - Method in class org.dataone.service.types.v1_1.QueryField
Get 'description' element item by position.
getDescriptionList() - Method in class org.dataone.service.types.v1_1.QueryField
Get the list of 'description' element items.
getDetail_code() - Method in exception org.dataone.service.exceptions.BaseException
 
getDocumentedBy(Identifier) - Method in class org.dataone.client.DataPackage
Convenience function for working with the metadata map.
getEmail(int) - Method in class org.dataone.service.types.v1.Person
Get 'email' element item by position.
getEmailList() - Method in class org.dataone.service.types.v1.Person
Get the list of 'email' element items.
getEntryId() - Method in class org.dataone.service.types.v1.LogEntry
Get the 'entryId' element value.
getEquivalentIdentity(int) - Method in class org.dataone.service.types.v1.Person
Get 'equivalentIdentity' element item by position.
getEquivalentIdentityList() - Method in class org.dataone.service.types.v1.Person
Get the list of 'equivalentIdentity' element items.
getEvent() - Method in class org.dataone.service.types.v1.LogEntry
Get the 'event' element value.
getExtension(String) - Method in class org.dataone.client.formats.ObjectFormatInfo
Look up the extension for an ObjectFormat based on the format identifier for that ObjectFormat.
getExtension(ObjectFormat) - Method in class org.dataone.client.formats.ObjectFormatInfo
Look up the extension for an ObjectFormat.
getExtensionValue(X509Certificate, String) - Method in class org.dataone.client.auth.CertificateManager
Retrieves the extension value given by the OID
getFamilyName() - Method in class org.dataone.service.types.v1.Person
Get the 'familyName' element value.
getFmtId() - Method in class org.dataone.client.D1Object
Deprecated.
getFormat(ObjectFormatIdentifier) - Method in class org.dataone.client.CNode
Return the ObjectFormat for the given ObjectFormatIdentifier, obtained either from a client-cached ObjectFormatList from the ObjectFormatCache, or from a call to the CN.
getFormat(String) - Method in class org.dataone.client.ObjectFormatCache
Deprecated.
getFormat(ObjectFormatIdentifier) - Method in class org.dataone.client.ObjectFormatCache
Lookup and return the format specified by the Identifier.
getFormat(ObjectFormatIdentifier) - Method in interface org.dataone.service.cn.v1.CNCore
 
getFormat(ObjectFormatIdentifier) - Method in class org.dataone.service.types.v1.util.ObjectFormatServiceImpl
Get the object format based on the given identifier.
getFormatId() - Method in class org.dataone.client.D1Object
 
getFormatId() - Method in class org.dataone.service.types.v1.ObjectFormat
Get the 'formatId' element value.
getFormatId() - Method in class org.dataone.service.types.v1.ObjectInfo
Get the 'formatId' element value.
getFormatId() - Method in class org.dataone.service.types.v1.SystemMetadata
Get the 'formatId' element value.
getFormatName() - Method in class org.dataone.service.types.v1.ObjectFormat
Get the 'formatName' element value.
getFormatType() - Method in class org.dataone.service.types.v1.ObjectFormat
Get the 'formatType' element value.
getGivenName(int) - Method in class org.dataone.service.types.v1.Person
Get 'givenName' element item by position.
getGivenNameList() - Method in class org.dataone.service.types.v1.Person
Get the list of 'givenName' element items.
getGroup(int) - Method in class org.dataone.service.types.v1.SubjectInfo
Get 'group' element item by position.
getGroupList() - Method in class org.dataone.service.types.v1.SubjectInfo
Get the list of 'group' element items.
getGroupName() - Method in class org.dataone.service.types.v1.Group
Get the 'groupName' element value.
getHasMember(int) - Method in class org.dataone.service.types.v1.Group
Get 'hasMember' element item by position.
getHasMemberList() - Method in class org.dataone.service.types.v1.Group
Get the list of 'hasMember' element items.
getHeader(String) - Method in class org.dataone.mimemultipart.MultipartRequest
 
getHeaderNames() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getHeaders(String) - Method in class org.dataone.mimemultipart.MultipartRequest
 
getHits() - Method in class org.dataone.client.cache.LocalCache
Returns the cache hits, the number of times that objects are requested and found in the cache since the last time that counters were reset.
getHour() - Method in class org.dataone.service.types.v1.Schedule
Get the 'hour' attribute value.
getHttpClient() - Method in class org.dataone.client.D1RestClient
Gets the AbstractHttpClient instance used to make the connection
getHttpClient() - Method in class org.dataone.client.RestClient
Gets the DefaultHttpClient instance used to make the connection
getHttpClient() - Method in class org.dataone.mimemultipart.MultipartRequestHandler
Deprecated.
 
getIdentifier() - Method in class org.dataone.client.D1Object
 
getIdentifier() - Method in class org.dataone.service.types.v1.LogEntry
Get the 'identifier' element value.
getIdentifier() - Method in class org.dataone.service.types.v1.Node
Get the 'identifier' element value.
getIdentifier() - Method in class org.dataone.service.types.v1.ObjectInfo
Get the 'identifier' element value.
getIdentifier() - Method in class org.dataone.service.types.v1.ObjectLocationList
Get the 'identifier' element value.
getIdentifier() - Method in class org.dataone.service.types.v1.SystemMetadata
Get the 'identifier' element value.
getInputStream() - Method in class org.dataone.client.InputStreamDataSource
get the InputStream from this data source
getInputStream() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getInstance() - Static method in class org.dataone.client.auth.CertificateManager
Return the singleton instance of this CertificateManager, creating it if needed.
getInstance() - Static method in class org.dataone.client.ObjectFormatCache
Create the object format cache instance if it hasn't already been created.
getInstance() - Static method in class org.dataone.eml.DataoneEMLParser
singleton accessor
getInstance() - Static method in class org.dataone.ore.ResourceMapFactory
Returns the singleton instance for this class.
getInstance() - Static method in class org.dataone.service.types.v1.util.ObjectFormatServiceImpl
Get the instance of the ObjectFormatServiceImpl that has been instantiated, or instantiate one if it has not been already.
getIntHeader(String) - Method in class org.dataone.mimemultipart.MultipartRequest
 
getIpAddress() - Method in class org.dataone.service.types.v1.LogEntry
Get the 'ipAddress' element value.
getIsMemberOf(int) - Method in class org.dataone.service.types.v1.Person
Get 'isMemberOf' element item by position.
getIsMemberOfList() - Method in class org.dataone.service.types.v1.Person
Get the list of 'isMemberOf' element items.
getLast_Modified() - Method in class org.dataone.service.types.v1.DescribeResponse
get DateTime value that indicates when the system metadata associated with the object was last modified, i.e.
getLastCompleteHarvest() - Method in class org.dataone.service.types.v1.Synchronization
Get the 'lastCompleteHarvest' element value.
getLastHarvested() - Method in class org.dataone.service.types.v1.Synchronization
Get the 'lastHarvested' element value.
getLastRefreshDate() - Method in class org.dataone.client.ObjectFormatCache
Returns the date of the last refresh from the CN.
getLastSuccess() - Method in class org.dataone.service.types.v1.Ping
Get the 'lastSuccess' attribute value.
getLastTempfile() - Method in class org.dataone.mimemultipart.SimpleMultipartEntity
 
getLatestRequestUrl() - Method in class org.dataone.client.D1Node
Useful for debugging to see what the last call was
getLatestRequestUrl() - Method in class org.dataone.client.D1RestClient
Gets the string representation of the latest http call made by the underlying RestClient
getLatestRequestUrl() - Method in class org.dataone.client.RestClient
 
getLatestVersion() - Method in class org.dataone.client.types.ObsoletesChain
 
getLocalAddr() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getLocale() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getLocales() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getLocalName() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getLocalPort() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getLogEntry(int) - Method in class org.dataone.service.types.v1.Log
Get 'logEntry' element item by position.
getLogEntryList() - Method in class org.dataone.service.types.v1.Log
Get the list of 'logEntry' element items.
getLogRecords() - Method in class org.dataone.client.CNode
A convenience method for getLogRecords using no filtering parameters see DataONE API Reference
getLogRecords(Session) - Method in class org.dataone.client.CNode
A convenience method for getLogRecords using no filtering parameters see DataONE API Reference
getLogRecords(Date, Date, Event, String, Integer, Integer) - Method in class org.dataone.client.CNode
getLogRecords(Session, Date, Date, Event, String, Integer, Integer) - Method in class org.dataone.client.CNode
getLogRecords() - Method in class org.dataone.client.D1Node
 
getLogRecords(Session) - Method in class org.dataone.client.D1Node
 
getLogRecords(Date, Date, Event, String, Integer, Integer) - Method in class org.dataone.client.D1Node
 
getLogRecords(Session, Date, Date, Event, String, Integer, Integer) - Method in class org.dataone.client.D1Node
 
getLogRecords() - Method in class org.dataone.client.MNode
getLogRecords(Session) - Method in class org.dataone.client.MNode
getLogRecords(Date, Date, Event, String, Integer, Integer) - Method in class org.dataone.client.MNode
getLogRecords(Session, Date, Date, Event, String, Integer, Integer) - Method in class org.dataone.client.MNode
getLogRecords(Date, Date, Event, String, Integer, Integer) - Method in interface org.dataone.service.cn.v1.CNCore
 
getLogRecords(Session, Date, Date, Event, String, Integer, Integer) - Method in interface org.dataone.service.cn.v1.CNCore
Deprecated.
getLogRecords(Date, Date, Event, String, Integer, Integer) - Method in interface org.dataone.service.mn.tier1.v1.MNCore
 
getLogRecords(Session, Date, Date, Event, String, Integer, Integer) - Method in interface org.dataone.service.mn.tier1.v1.MNCore
Deprecated.
getMap() - Method in class org.dataone.client.DataPackage
Build and return a fresh ORE ResourceMap from the metadata map.
getMaxObjectSize() - Method in class org.dataone.service.types.v1.NodeReplicationPolicy
Get the 'maxObjectSize' element value.
getMday() - Method in class org.dataone.service.types.v1.Schedule
Get the 'mday' attribute value.
getMetadataMap() - Method in class org.dataone.client.DataPackage
 
getMethod() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getMethodName() - Method in class org.dataone.service.types.v1.ServiceMethodRestriction
Get the 'methodName' attribute value.
getMimeType(String) - Method in class org.dataone.client.formats.ObjectFormatInfo
Look up the mime type for an ObjectFormat based on the format identifier for that ObjectFormat.
getMimeType(ObjectFormat) - Method in class org.dataone.client.formats.ObjectFormatInfo
Look up the mime type for an ObjectFormat.
getMin() - Method in class org.dataone.service.types.v1.Schedule
Get the 'min' attribute value.
getMinimalRefreshInterval() - Method in class org.dataone.client.ObjectFormatCache
Returns the minimal refresh interval (seconds)
getMisses() - Method in class org.dataone.client.cache.LocalCache
Returns the cache misses, the number of times that objects are requested but are not found in the cache since the last time that counters were reset.
getMN(String) - Static method in class org.dataone.client.D1Client
Construct and return a Member Node using the base service URL for the node.
getMN(NodeReference) - Static method in class org.dataone.client.D1Client
Construct and return a Member Node using the nodeReference for the member node.
getMon() - Method in class org.dataone.service.types.v1.Schedule
Get the 'mon' attribute value.
getMonitorInfo(int) - Method in class org.dataone.service.types.v1.MonitorList
Get 'monitorInfo' element item by position.
getMonitorInfoList() - Method in class org.dataone.service.types.v1.MonitorList
Get the list of 'monitorInfo' element items.
getMultipartFiles() - Method in class org.dataone.mimemultipart.MultipartRequest
Return the multipart files as Map of field name to MultipartFile instance.
getMultipartParameters() - Method in class org.dataone.mimemultipart.MultipartRequest
Return the multipart parameters as Map of field name to form field String value.
getMultivalued() - Method in class org.dataone.service.types.v1_1.QueryField
Get the 'multivalued' element value.
getName() - Method in class org.dataone.client.InputStreamDataSource
get the name of the data source.
getName() - Method in class org.dataone.service.types.v1.Node
Get the 'name' element value.
getName() - Method in class org.dataone.service.types.v1.Service
Get the 'name' attribute value.
getName() - Method in class org.dataone.service.types.v1_1.QueryEngineDescription
Get the 'name' element value.
getName() - Method in class org.dataone.service.types.v1_1.QueryField
Get the 'name' element value.
getNode(int) - Method in class org.dataone.service.types.v1.NodeList
Get 'node' element item by position.
getNodeBaseServiceUrl() - Method in class org.dataone.client.CNode
 
getNodeBaseServiceUrl() - Method in class org.dataone.client.D1Node
Retrieve the service URL for this node.
getNodeBaseServiceUrl() - Method in class org.dataone.client.MNode
 
getNodeId() - Method in class org.dataone.client.D1Node
 
getNodeId() - Method in exception org.dataone.service.exceptions.BaseException
Get the node Id string
getNodeIdentifier() - Method in class org.dataone.service.types.v1.LogEntry
Get the 'nodeIdentifier' element value.
getNodeIdentifier() - Method in class org.dataone.service.types.v1.ObjectLocation
Get the 'nodeIdentifier' element value.
getNodeList() - Method in class org.dataone.service.types.v1.NodeList
Get the list of 'node' element items.
getNodeReplicationPolicy() - Method in class org.dataone.service.types.v1.Node
Get the 'nodeReplicationPolicy' element value.
getNumberReplicas() - Method in class org.dataone.service.types.v1.ReplicationPolicy
Get the 'numberReplicas' attribute value.
getObjectFormat(int) - Method in class org.dataone.service.types.v1.ObjectFormatList
Get 'objectFormat' element item by position.
getObjectFormatFile() - Method in class org.dataone.service.types.v1.util.ObjectFormatServiceImpl
Convenience method to retrieve the default format list as a stream
getObjectFormatList() - Method in class org.dataone.service.types.v1.ObjectFormatList
Get the list of 'objectFormat' element items.
getObjectFormatMap() - Method in class org.dataone.service.types.v1.util.ObjectFormatServiceImpl
Return the hash containing the formatId and format mapping
getObjectInfo(int) - Method in class org.dataone.service.types.v1.ObjectList
Get 'objectInfo' element item by position.
getObjectInfoList() - Method in class org.dataone.service.types.v1.ObjectList
Get the list of 'objectInfo' element items.
getObjectLocation(int) - Method in class org.dataone.service.types.v1.ObjectLocationList
Get 'objectLocation' element item by position.
getObjectLocationList() - Method in class org.dataone.service.types.v1.ObjectLocationList
Get the list of 'objectLocation' element items.
getObsoletedBy() - Method in class org.dataone.service.types.v1.SystemMetadata
Get the 'obsoletedBy' element value.
getObsoletes() - Method in class org.dataone.service.types.v1.SystemMetadata
Get the 'obsoletes' element value.
getOREModel() - Method in class org.dataone.ore.ResourceMapFactory
this method optimizes retrieving and caching the ORE model, used for reasoning model
getOriginalVersion() - Method in class org.dataone.client.types.ObsoletesChain
 
getOriginMemberNode() - Method in class org.dataone.service.types.v1.SystemMetadata
Get the 'originMemberNode' element value.
getOutputStream() - Method in class org.dataone.client.InputStreamDataSource
get an output stream for this data source.
getPackageId() - Method in class org.dataone.client.DataPackage
 
getParameter(String) - Method in class org.dataone.mimemultipart.MultipartRequest
 
getParameterMap() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getParameterNames() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getParameterValues(String) - Method in class org.dataone.mimemultipart.MultipartRequest
 
getPathInfo() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getPathTranslated() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getPendingMapIdentity(Subject) - Method in class org.dataone.client.CNode
getPendingMapIdentity(Session, Subject) - Method in class org.dataone.client.CNode
getPendingMapIdentity(Subject) - Method in interface org.dataone.service.cn.v1.CNIdentity
 
getPendingMapIdentity(Session, Subject) - Method in interface org.dataone.service.cn.v1.CNIdentity
Deprecated.
getPermission(int) - Method in class org.dataone.service.types.v1.AccessRule
Get 'permission' element item by position.
getPermissionList() - Method in class org.dataone.service.types.v1.AccessRule
Get the list of 'permission' element items.
getPermissionMap(AccessPolicy) - Static method in class org.dataone.service.types.v1.util.AccessUtil
 
getPerson(int) - Method in class org.dataone.service.types.v1.SubjectInfo
Get 'person' element item by position.
getPersonList() - Method in class org.dataone.service.types.v1.SubjectInfo
Get the list of 'person' element items.
getPid() - Method in exception org.dataone.service.exceptions.BaseException
 
getPing() - Method in class org.dataone.service.types.v1.Node
Get the 'ping' element value.
getPreference() - Method in class org.dataone.service.types.v1.ObjectLocation
Get the 'preference' element value.
getPreferredMemberNode(int) - Method in class org.dataone.service.types.v1.ReplicationPolicy
Get 'preferredMemberNode' element item by position.
getPreferredMemberNodeList() - Method in class org.dataone.service.types.v1.ReplicationPolicy
Get the list of 'preferredMemberNode' element items.
getProtocol() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getPublishDate(Identifier) - Method in class org.dataone.client.types.ObsoletesChain
 
getQueryEngine(int) - Method in class org.dataone.service.types.v1_1.QueryEngineList
Get 'queryEngine' element item by position.
getQueryEngineDescription(String) - Method in class org.dataone.client.CNode
getQueryEngineDescription(String) - Method in class org.dataone.client.D1Node
 
getQueryEngineDescription(String) - Method in class org.dataone.client.MNode
getQueryEngineDescription(String) - Method in interface org.dataone.service.cn.v1.CNRead
 
getQueryEngineDescription(String) - Method in interface org.dataone.service.mn.v1.MNQuery
 
getQueryEngineList() - Method in class org.dataone.service.types.v1_1.QueryEngineList
Get the list of 'queryEngine' element items.
getQueryEngineVersion() - Method in class org.dataone.service.types.v1_1.QueryEngineDescription
Get the 'queryEngineVersion' element value.
getQueryField(int) - Method in class org.dataone.service.types.v1_1.QueryEngineDescription
Get 'queryField' element item by position.
getQueryFieldList() - Method in class org.dataone.service.types.v1_1.QueryEngineDescription
Get the list of 'queryField' element items.
getQuerySchemaVersion() - Method in class org.dataone.service.types.v1_1.QueryEngineDescription
Get the 'querySchemaVersion' element value.
getQueryString() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getReader() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getRealPath(String) - Method in class org.dataone.mimemultipart.MultipartRequest
 
getRemoteAddr() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getRemoteHost() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getRemotePort() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getRemoteUser() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getReplica(Identifier) - Method in class org.dataone.client.MNode
getReplica(Session, Identifier) - Method in class org.dataone.client.MNode
getReplica(Identifier) - Method in interface org.dataone.service.mn.tier1.v1.MNRead
 
getReplica(Session, Identifier) - Method in interface org.dataone.service.mn.tier1.v1.MNRead
Deprecated.
getReplica(int) - Method in class org.dataone.service.types.v1.SystemMetadata
Get 'replica' element item by position.
getReplicaList() - Method in class org.dataone.service.types.v1.SystemMetadata
Get the list of 'replica' element items.
getReplicaMemberNode() - Method in class org.dataone.service.types.v1.Replica
Get the 'replicaMemberNode' element value.
getReplicationAllowed() - Method in class org.dataone.service.types.v1.ReplicationPolicy
Get the 'replicationAllowed' attribute value.
getReplicationPolicy() - Method in class org.dataone.service.types.v1.SystemMetadata
Get the 'replicationPolicy' element value.
getReplicationStatus() - Method in class org.dataone.service.types.v1.Replica
Get the 'replicationStatus' element value.
getReplicaVerified() - Method in class org.dataone.service.types.v1.Replica
Get the 'replicaVerified' element value.
getRequest() - Method in class org.dataone.mimemultipart.MultipartRequestHandler
Deprecated.
Returns the request for use by any org.apache.http.client.HttpClient
getRequestDispatcher(String) - Method in class org.dataone.mimemultipart.MultipartRequest
 
getRequestedSessionId() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getRequestURI() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getRequestURL() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getResetConfiguration() - Static method in class org.dataone.configuration.Settings
 
getResource() - Method in class org.dataone.service.util.D1Url
 
getRestriction(int) - Method in class org.dataone.service.types.v1.Service
Get 'restriction' element item by position.
getRestrictionList() - Method in class org.dataone.service.types.v1.Service
Get the list of 'restriction' element items.
getRightsHolder(int) - Method in class org.dataone.service.types.v1.Group
Get 'rightsHolder' element item by position.
getRightsHolder() - Method in class org.dataone.service.types.v1.SystemMetadata
Get the 'rightsHolder' element value.
getRightsHolderList() - Method in class org.dataone.service.types.v1.Group
Get the list of 'rightsHolder' element items.
getSchedule() - Method in class org.dataone.service.types.v1.Synchronization
Get the 'schedule' element value.
getScheme() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getSec() - Method in class org.dataone.service.types.v1.Schedule
Get the 'sec' attribute value.
getSerialVersion() - Method in class org.dataone.service.types.v1.DescribeResponse
get the SerialVersion of the object SystemMetadata
getSerialVersion() - Method in class org.dataone.service.types.v1.SystemMetadata
Get the 'serialVersion' element value.
getServerName() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getServerPort() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getService(int) - Method in class org.dataone.service.types.v1.Services
Get 'service' element item by position.
getServiceList() - Method in class org.dataone.service.types.v1.Services
Get the list of 'service' element items.
getServices() - Method in class org.dataone.service.types.v1.Node
Get the 'services' element value.
getServletPath() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getSession(HttpServletRequest) - Method in class org.dataone.client.auth.CertificateManager
extracts the principal from the certificate passed in with the request and creates the dataone Session object.
getSession(HttpServletRequest, boolean) - Method in class org.dataone.client.auth.CertificateManager
extracts the principal from the certificate passed in with the request and creates the dataone Session object.
getSession(boolean) - Method in class org.dataone.mimemultipart.MultipartRequest
 
getSession() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getSize() - Method in class org.dataone.service.types.v1.ObjectInfo
Get the 'size' element value.
getSize() - Method in class org.dataone.service.types.v1.SystemMetadata
Get the 'size' element value.
getSpaceAllocated() - Method in class org.dataone.service.types.v1.NodeReplicationPolicy
Get the 'spaceAllocated' element value.
getSSLSocketFactory(String) - Method in class org.dataone.client.auth.CertificateManager
For use by clients making requests via SSL connection.
getStart() - Method in class org.dataone.service.types.v1.Slice
Get the 'start' attribute value.
getStartingPoint() - Method in class org.dataone.client.types.ObsoletesChain
 
getState() - Method in class org.dataone.service.types.v1.Node
Get the 'state' attribute value.
getSubject(int) - Method in class org.dataone.service.types.v1.AccessRule
Get 'subject' element item by position.
getSubject() - Method in class org.dataone.service.types.v1.Group
Get the 'subject' element value.
getSubject() - Method in class org.dataone.service.types.v1.LogEntry
Get the 'subject' element value.
getSubject(int) - Method in class org.dataone.service.types.v1.Node
Get 'subject' element item by position.
getSubject() - Method in class org.dataone.service.types.v1.Person
Get the 'subject' element value.
getSubject() - Method in class org.dataone.service.types.v1.Session
Get the 'subject' element value.
getSubject(int) - Method in class org.dataone.service.types.v1.SubjectList
Get 'subject' element item by position.
getSubjectDN(X509Certificate) - Method in class org.dataone.client.auth.CertificateManager
Returns the RFC2253 string representation for the certificate's subject This is the standard format used in DataONE.
getSubjectInfo(X509Certificate) - Method in class org.dataone.client.auth.CertificateManager
Retrieve the SubjectInfo contained in the given certificate
getSubjectInfo(Subject) - Method in class org.dataone.client.CNode
getSubjectInfo(Session, Subject) - Method in class org.dataone.client.CNode
getSubjectInfo(Subject) - Method in interface org.dataone.service.cn.v1.CNIdentity
 
getSubjectInfo(Session, Subject) - Method in interface org.dataone.service.cn.v1.CNIdentity
Deprecated.
getSubjectInfo() - Method in class org.dataone.service.types.v1.Session
Get the 'subjectInfo' element value.
getSubjectList() - Method in class org.dataone.service.types.v1.AccessRule
Get the list of 'subject' element items.
getSubjectList() - Method in class org.dataone.service.types.v1.Node
Get the list of 'subject' element items.
getSubjectList() - Method in class org.dataone.service.types.v1.SubjectList
Get the list of 'subject' element items.
getSubmitter() - Method in class org.dataone.service.types.v1.SystemMetadata
Get the 'submitter' element value.
getSuccess() - Method in class org.dataone.service.types.v1.Ping
Get the 'success' attribute value.
getSynchronization() - Method in class org.dataone.service.types.v1.Node
Get the 'synchronization' element value.
getSystemMetadata(Identifier) - Method in class org.dataone.client.cache.LocalCache
Retrieve a SystemMetadata from the cache, throwing NotCached if the system metadata for the Identifier key is not in the cache.
getSystemMetadata(Identifier) - Method in class org.dataone.client.CNode
 
getSystemMetadata(Session, Identifier) - Method in class org.dataone.client.CNode
 
getSystemMetadata(Identifier) - Method in class org.dataone.client.D1Node
Get the system metadata from a resource with the specified guid.
getSystemMetadata(Identifier, boolean) - Method in class org.dataone.client.D1Node
Get the system metadata from a resource with the specified guid, potentially using the local system metadata cache if specified to do so.
getSystemMetadata(Session, Identifier) - Method in class org.dataone.client.D1Node
Get the system metadata from a resource with the specified guid.
getSystemMetadata(Session, Identifier, boolean) - Method in class org.dataone.client.D1Node
Get the system metadata from a resource with the specified guid, potentially using the local system metadata cache if specified to do so.
getSystemMetadata() - Method in class org.dataone.client.D1Object
 
getSystemMetadata() - Method in class org.dataone.client.DataPackage
Get the SystemMetadata object associated with the data package.
getSystemMetadata(Identifier) - Method in class org.dataone.client.MNode
 
getSystemMetadata(Session, Identifier) - Method in class org.dataone.client.MNode
 
getSystemMetadata(Identifier) - Method in interface org.dataone.service.cn.v1.CNRead
 
getSystemMetadata(Session, Identifier) - Method in interface org.dataone.service.cn.v1.CNRead
Deprecated.
getSystemMetadata(Identifier) - Method in interface org.dataone.service.mn.tier1.v1.MNRead
 
getSystemMetadata(Session, Identifier) - Method in interface org.dataone.service.mn.tier1.v1.MNRead
Deprecated.
getTotal() - Method in class org.dataone.service.types.v1.Slice
Get the 'total' attribute value.
getTraceDetail(String) - Method in exception org.dataone.service.exceptions.BaseException
Get the value of one of the trace detail parametersm retrieved by its key value.
getTraceKeySet() - Method in exception org.dataone.service.exceptions.BaseException
Return a Set representation of all of the keys for the trace values in this exception.
getType() - Method in class org.dataone.service.types.v1.Node
Get the 'type' attribute value.
getType() - Method in class org.dataone.service.types.v1_1.QueryField
Get the 'type' element value.
getUncharacterizedMembers() - Method in class org.dataone.client.DataPackage
Returns a list of package members that are not in the relationship map (implying that these are not true members, as they will not be included in the serialized ResourceMap).
getUnresolvableMembers() - Method in class org.dataone.client.DataPackage
Returns the Identifiers in the relationship map that cannot be found in the object map or resolved by the CN.
getUrl() - Method in class org.dataone.service.types.v1.ObjectLocation
Get the 'url' element value.
getUrl() - Method in class org.dataone.service.util.D1Url
 
getUserAgent() - Method in class org.dataone.service.types.v1.LogEntry
Get the 'userAgent' element value.
getUserPrincipal() - Method in class org.dataone.mimemultipart.MultipartRequest
 
getValue() - Method in class org.dataone.service.types.v1.Checksum
Get the extension value.
getValue() - Method in class org.dataone.service.types.v1.Identifier
Get the 'Identifier' complexType value.
getValue() - Method in class org.dataone.service.types.v1.NodeReference
Get the 'NodeReference' complexType value.
getValue() - Method in class org.dataone.service.types.v1.ObjectFormatIdentifier
Get the 'ObjectFormatIdentifier' simpleType value.
getValue() - Method in class org.dataone.service.types.v1.Subject
Get the 'Subject' complexType value.
getVerified() - Method in class org.dataone.service.types.v1.Person
Get the 'verified' element value.
getVersion(int) - Method in class org.dataone.service.types.v1.ObjectLocation
Get 'version' element item by position.
getVersion() - Method in class org.dataone.service.types.v1.Service
Get the 'version' attribute value.
getVersionAsOf(Date) - Method in class org.dataone.client.types.ObsoletesChain
 
getVersionList() - Method in class org.dataone.service.types.v1.ObjectLocation
Get the list of 'version' element items.
getWday() - Method in class org.dataone.service.types.v1.Schedule
Get the 'wday' attribute value.
getYear() - Method in class org.dataone.service.types.v1.Schedule
Get the 'year' attribute value.
Group - Class in org.dataone.service.types.v1
Group represents metadata about a :term:`Subject` that represents a collection of other Subjects.
Group() - Constructor for class org.dataone.service.types.v1.Group
 
GroupNameComparator - Class in org.dataone.service.types.v1.comparators
A comparator for comparing the Group objects base on the group name.
GroupNameComparator() - Constructor for class org.dataone.service.types.v1.comparators.GroupNameComparator
 

H

hasAccess(Subject, Permission) - Method in class org.dataone.client.AccessPolicyEditor
 
hashCode() - Method in class org.dataone.service.types.v1.Identifier
return the hashcode of Identifier's string value.
hashCode() - Method in class org.dataone.service.types.v1.NodeReference
return the hashcode of NodeReference's string value.
hashCode() - Method in class org.dataone.service.types.v1.ObjectFormatIdentifier
return the hashcode of ObjectFormatIdentifier's string value.
hashCode() - Method in class org.dataone.service.types.v1.Subject
return the hashcode of Subject's string value.
hasReservation(Subject, Identifier) - Method in class org.dataone.client.CNode
hasReservation(Session, Subject, Identifier) - Method in class org.dataone.client.CNode
hasReservation(Subject, Identifier) - Method in interface org.dataone.service.cn.v1.CNCore
 
hasReservation(Session, Subject, Identifier) - Method in interface org.dataone.service.cn.v1.CNCore
Deprecated.
HEAD - Static variable in class org.dataone.service.util.Constants
HTTP Verb HEAD

I

Identifier - Class in org.dataone.service.types.v1
An :term:`identifier` (:term:`PID`) in the DataONE system that is used to uniquely and globally identify an object.
Identifier() - Constructor for class org.dataone.service.types.v1.Identifier
 
IdentifierNotUnique - Exception in org.dataone.service.exceptions
The DataONE IdentifierNotUnique exception, raised when a requested identifier has already been used or reserved.
IdentifierNotUnique(String, String) - Constructor for exception org.dataone.service.exceptions.IdentifierNotUnique
 
IdentifierNotUnique(String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.IdentifierNotUnique
 
IdentifierNotUnique(String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.IdentifierNotUnique
 
IdentifierNotUnique(String, String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.IdentifierNotUnique
 
identifiers() - Method in class org.dataone.client.DataPackage
Return the set of Identifiers that are part of this package.
InputStreamDataSource - Class in org.dataone.client
Encapsulate an InputStream within a DataSource interface so that it is accessible to MIME processors.
InputStreamDataSource(String, InputStream) - Constructor for class org.dataone.client.InputStreamDataSource
construct an InputStreamDataSource object
insertRelationship(Identifier, List<Identifier>) - Method in class org.dataone.client.DataPackage
Declare which data objects are documented by a metadata object, using their identifiers.
instance() - Static method in class org.dataone.client.cache.LocalCache
Get the singleton instance of the LocalCache that can be used to perform cache operations.
instance() - Static method in class org.dataone.client.formats.ObjectFormatInfo
Get the single instance of this class, creating it when needed on first invocation.
InsufficientResources - Exception in org.dataone.service.exceptions
The DataONE InsufficientResources exception, raised when insufficient space, bandwidth, or other resources are available to complete a request.
InsufficientResources(String, String) - Constructor for exception org.dataone.service.exceptions.InsufficientResources
 
InsufficientResources(String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.InsufficientResources
 
InsufficientResources(String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.InsufficientResources
 
InsufficientResources(String, String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.InsufficientResources
 
InvalidCredentials - Exception in org.dataone.service.exceptions
The DataONE InvalidCredentials exception, raised when a request is issued for which the credentials were not validated.
InvalidCredentials(String, String) - Constructor for exception org.dataone.service.exceptions.InvalidCredentials
 
InvalidCredentials(String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.InvalidCredentials
 
InvalidCredentials(String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.InvalidCredentials
 
InvalidCredentials(String, String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.InvalidCredentials
 
InvalidRequest - Exception in org.dataone.service.exceptions
The DataONE InvalidRequest exception, raised when a request is issued for which one or more parameters provided in the call were invalid.
InvalidRequest(String, String) - Constructor for exception org.dataone.service.exceptions.InvalidRequest
 
InvalidRequest(String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.InvalidRequest
 
InvalidRequest(String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.InvalidRequest
 
InvalidRequest(String, String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.InvalidRequest
 
InvalidSystemMetadata - Exception in org.dataone.service.exceptions
The DataONE InvalidSystemMetadata exception, raised when a request is issued and the supplied system metadata is invalid.
InvalidSystemMetadata(String, String) - Constructor for exception org.dataone.service.exceptions.InvalidSystemMetadata
 
InvalidSystemMetadata(String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.InvalidSystemMetadata
 
InvalidSystemMetadata(String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.InvalidSystemMetadata
 
InvalidSystemMetadata(String, String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.InvalidSystemMetadata
 
InvalidToken - Exception in org.dataone.service.exceptions
The DataONE InvalidToken exception, raised when supplied authentication token could not be verified as being valid.
InvalidToken(String, String) - Constructor for exception org.dataone.service.exceptions.InvalidToken
 
InvalidToken(String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.InvalidToken
 
InvalidToken(String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.InvalidToken
 
InvalidToken(String, String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.InvalidToken
 
isArchived(Identifier) - Method in class org.dataone.client.types.ObsoletesChain
 
isAuthorized(Identifier, Permission) - Method in class org.dataone.client.CNode
isAuthorized(Session, Identifier, Permission) - Method in class org.dataone.client.CNode
isAuthorized(Identifier, Permission) - Method in class org.dataone.client.D1Node
 
isAuthorized(Session, Identifier, Permission) - Method in class org.dataone.client.D1Node
 
isAuthorized(Identifier, Permission) - Method in class org.dataone.client.MNode
isAuthorized(Session, Identifier, Permission) - Method in class org.dataone.client.MNode
isAuthorized(Identifier, Permission) - Method in interface org.dataone.service.cn.v1.CNAuthorization
 
isAuthorized(Session, Identifier, Permission) - Method in interface org.dataone.service.cn.v1.CNAuthorization
Deprecated.
isAuthorized(Identifier, Permission) - Method in interface org.dataone.service.mn.tier2.v1.MNAuthorization
 
isAuthorized(Session, Identifier, Permission) - Method in interface org.dataone.service.mn.tier2.v1.MNAuthorization
Deprecated.
isAuthorized(Collection<Subject>, Permission, SystemMetadata) - Static method in class org.dataone.service.types.v1.util.AuthUtils
Queries the systemMetadata to see if one of the given subjects is allowed the specified permission against the given systemMetadata
isComplete() - Method in class org.dataone.client.types.ObsoletesChain
An ObsoletesChain is complete when the earliest and latest links have no obsoletedBy and obsoletes, respectively.
isException() - Method in class org.dataone.service.util.ExceptionalInputStream
 
isLatestVersion(Identifier) - Method in class org.dataone.client.types.ObsoletesChain
 
isMethodAllowed(Subject, List<Node>, String, String) - Static method in class org.dataone.service.types.v1.util.ServiceMethodRestrictionUtil
Interprets the CN's ServiceMethodRestriction for a given Subject+serviceName+methodName
isMultipartContent(HttpServletRequest) - Static method in class org.dataone.mimemultipart.MultipartRequestResolver
 
isNodeAuthorized(Subject, Identifier) - Method in class org.dataone.client.CNode
isNodeAuthorized(Session, Subject, Identifier) - Method in class org.dataone.client.CNode
isNodeAuthorized(Subject, Identifier) - Method in interface org.dataone.service.cn.v1.CNReplication
 
isNodeAuthorized(Session, Subject, Identifier) - Method in interface org.dataone.service.cn.v1.CNReplication
Deprecated.
isReplicate() - Method in class org.dataone.service.types.v1.Node
Get the 'replicate' attribute value.
isRequestedSessionIdFromCookie() - Method in class org.dataone.mimemultipart.MultipartRequest
 
isRequestedSessionIdFromURL() - Method in class org.dataone.mimemultipart.MultipartRequest
 
isRequestedSessionIdFromUrl() - Method in class org.dataone.mimemultipart.MultipartRequest
 
isRequestedSessionIdValid() - Method in class org.dataone.mimemultipart.MultipartRequest
 
isReturnable() - Method in class org.dataone.service.types.v1_1.QueryField
Get the 'returnable' element value.
isSearchable() - Method in class org.dataone.service.types.v1_1.QueryField
Get the 'searchable' element value.
isSecure() - Method in class org.dataone.mimemultipart.MultipartRequest
 
isSortable() - Method in class org.dataone.service.types.v1_1.QueryField
Get the 'sortable' element value.
isSynchronize() - Method in class org.dataone.service.types.v1.Node
Get the 'synchronize' attribute value.
isUserInRole(String) - Method in class org.dataone.mimemultipart.MultipartRequest
 
isUsingFallbackFormatList() - Method in class org.dataone.client.ObjectFormatCache
Returns true if the cache has not been able to successfully refresh from the CN

J

joinToUrlWith(String, String) - Method in class org.dataone.service.util.D1Url
use this method to avoid inadvertent duplication of the joining character The most common case is when a baseUrl contains a trailing slash and you want to append another path elements.

L

lastRefreshDate - Variable in class org.dataone.client.ObjectFormatCache
 
latestIsArchived() - Method in class org.dataone.client.types.ObsoletesChain
 
listChecksumAlgorithms() - Method in class org.dataone.client.CNode
listChecksumAlgorithms() - Method in interface org.dataone.service.cn.v1.CNCore
 
listFormats() - Method in class org.dataone.client.CNode
listFormats() - Method in class org.dataone.client.ObjectFormatCache
List the object formats registered with the object format service.
listFormats() - Method in interface org.dataone.service.cn.v1.CNCore
 
listFormats() - Method in class org.dataone.service.types.v1.util.ObjectFormatServiceImpl
List the object formats registered with the object format service.
listNodeIds() - Method in class org.dataone.client.CNode
Return the set of Node IDs for all of the nodes registered to the CN
listNodes() - Method in class org.dataone.client.CNode
listNodes() - Method in interface org.dataone.service.cn.v1.CNCore
 
listObjects() - Method in class org.dataone.client.CNode
listObjects(Session) - Method in class org.dataone.client.CNode
listObjects(Date, Date, ObjectFormatIdentifier, Boolean, Integer, Integer) - Method in class org.dataone.client.CNode
listObjects(Session, Date, Date, ObjectFormatIdentifier, Boolean, Integer, Integer) - Method in class org.dataone.client.CNode
listObjects() - Method in class org.dataone.client.D1Node
listObjects(Session) - Method in class org.dataone.client.D1Node
 
listObjects(Date, Date, ObjectFormatIdentifier, Boolean, Integer, Integer) - Method in class org.dataone.client.D1Node
 
listObjects(Session, Date, Date, ObjectFormatIdentifier, Boolean, Integer, Integer) - Method in class org.dataone.client.D1Node
 
listObjects() - Method in class org.dataone.client.MNode
listObjects(Session) - Method in class org.dataone.client.MNode
listObjects(Date, Date, ObjectFormatIdentifier, Boolean, Integer, Integer) - Method in class org.dataone.client.MNode
listObjects(Session, Date, Date, ObjectFormatIdentifier, Boolean, Integer, Integer) - Method in class org.dataone.client.MNode
listObjects(Date, Date, ObjectFormatIdentifier, Boolean, Integer, Integer) - Method in interface org.dataone.service.cn.v1.CNRead
 
listObjects(Session, Date, Date, ObjectFormatIdentifier, Boolean, Integer, Integer) - Method in interface org.dataone.service.cn.v1.CNRead
Deprecated.
listObjects(Date, Date, ObjectFormatIdentifier, Boolean, Integer, Integer) - Method in interface org.dataone.service.mn.tier1.v1.MNRead
 
listObjects(Session, Date, Date, ObjectFormatIdentifier, Boolean, Integer, Integer) - Method in interface org.dataone.service.mn.tier1.v1.MNRead
Deprecated.
listQueryEngines() - Method in class org.dataone.client.CNode
listQueryEngines() - Method in class org.dataone.client.D1Node
 
listQueryEngines() - Method in class org.dataone.client.MNode
listQueryEngines() - Method in interface org.dataone.service.cn.v1.CNRead
 
listQueryEngines() - Method in interface org.dataone.service.mn.v1.MNQuery
 
listSubjects(String, String, Integer, Integer) - Method in class org.dataone.client.CNode
listSubjects(Session, String, String, Integer, Integer) - Method in class org.dataone.client.CNode
listSubjects(String, String, Integer, Integer) - Method in interface org.dataone.service.cn.v1.CNIdentity
 
listSubjects(Session, String, String, Integer, Integer) - Method in interface org.dataone.service.cn.v1.CNIdentity
Deprecated.
listUpdateHistory(Identifier) - Static method in class org.dataone.client.D1Client
Return the full ObsoletesChain for the given Identifier.
loadCertificate() - Method in class org.dataone.client.auth.CertificateManager
Load the configured certificate into the keystore singleton Follows the logic of first searching the certificate at the setCertificateLocation() location, then using the default location.
loadCertificateFromFile(String) - Method in class org.dataone.client.auth.CertificateManager
Load X509Certificate object from given file
loadKey() - Method in class org.dataone.client.auth.CertificateManager
Load configured private key from the keystore
loadPrivateKeyFromFile(String, String) - Method in class org.dataone.client.auth.CertificateManager
Load PrivateKey object from given file
LocalCache - Class in org.dataone.client.cache
LocalCache creates a local store of objects that can be locally accessed without incurring the overhead of remote service calls.
locateDefaultCertificate() - Method in class org.dataone.client.auth.CertificateManager
Locate the default certificate.
log - Static variable in class org.dataone.client.auth.ClientIdentityManager
 
log - Static variable in class org.dataone.client.CNode
 
log - Static variable in class org.dataone.client.D1Node
 
log - Static variable in class org.dataone.client.D1RestClient
 
log - Static variable in class org.dataone.client.MNode
 
log - Static variable in class org.dataone.client.RestClient
 
log - Static variable in class org.dataone.eml.DataoneEMLParser
 
Log - Class in org.dataone.service.types.v1
Represents a collection of :class:`Types.LogEntry` elements, used to transfer log information between DataONE components.
Log() - Constructor for class org.dataone.service.types.v1.Log
 
log - Static variable in class org.dataone.service.util.ExceptionHandler
 
LogEntry - Class in org.dataone.service.types.v1
A single log entry as reported by a Member Node or Coordinating Node through the :func:`MNCore.getLogRecords` or :func:`CNCore.getLogRecords` methods.
LogEntry() - Constructor for class org.dataone.service.types.v1.LogEntry
 
lookupNodeBaseUrl(String) - Method in class org.dataone.client.CNode
Find the base URL for a Node based on the Node's identifier as it was registered with the Coordinating Node.
lookupNodeBaseUrl(NodeReference) - Method in class org.dataone.client.CNode
Find the base URL for a Node based on the Node's identifier as it was registered with the Coordinating Node.
lookupNodeId(String) - Method in class org.dataone.client.CNode
Find the node identifier for a Node based on the base URL that is used to access its services by looking up the registration for the node at the Coordinating Node.

M

main(String[]) - Static method in class org.dataone.client.examples.ExampleClient
Execute the examples.
main(String[]) - Static method in class org.dataone.client.examples.ExampleDataPackageUpload
Demonstrates copying data package from a source CN to a target MN.
mapIdentity(Subject, Subject) - Method in class org.dataone.client.CNode
mapIdentity(Session, Subject, Subject) - Method in class org.dataone.client.CNode
mapIdentity(Subject, Subject) - Method in interface org.dataone.service.cn.v1.CNIdentity
 
mapIdentity(Session, Subject, Subject) - Method in interface org.dataone.service.cn.v1.CNIdentity
Deprecated.
mapNodeList(InputStream) - Static method in class org.dataone.service.types.v1.util.NodelistUtil
Convenience method of transferring nodeId and nodeBaseURL into a Map
mapNodeList(NodeList) - Static method in class org.dataone.service.types.v1.util.NodelistUtil
Convenience method of transferring nodeId and nodeBaseURL into a Map
marshalTypeToFile(Object, String) - Static method in class org.dataone.service.util.TypeMarshaller
 
marshalTypeToOutputStream(Object, OutputStream) - Static method in class org.dataone.service.util.TypeMarshaller
 
marshalTypeToOutputStream(Object, OutputStream, String) - Static method in class org.dataone.service.util.TypeMarshaller
Marshalls the typeObject to the provided outputStream.
mimeType - Variable in class org.dataone.eml.EMLDocument.DistributionMetadata
 
MNAuthorization - Interface in org.dataone.service.mn.tier2.v1
The DataONE Member Node Tier 2 Authorization interface.
MNCore - Interface in org.dataone.service.mn.tier1.v1
The DataONE Member Node Tier 1 Core interface.
MNode - Class in org.dataone.client
MNode represents a MemberNode, and exposes the services associated with a DataONE Member Node, allowing calling clients to call the services associated with the node.
MNode(String) - Constructor for class org.dataone.client.MNode
Construct a new client-side MNode (Member Node) object, passing in the base url of the member node for calling its services.
MNode(String, Session) - Constructor for class org.dataone.client.MNode
Construct a new client-side MNode (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.
MNQuery - Interface in org.dataone.service.mn.v1
The DataONE MemberNode Optional Query interface.
MNRead - Interface in org.dataone.service.mn.tier1.v1
The DataONE Member Node Tier 1 Read interface.
MNReplication - Interface in org.dataone.service.mn.tier4.v1
The DataONE Member Node Tier 4 Replication interface.
MNStorage - Interface in org.dataone.service.mn.tier3.v1
The DataONE Member Node Tier 3 Storage interface.
MonitorInfo - Class in org.dataone.service.types.v1
A single log entry as reported by a Member Node or Coordinating Node through the getMonitorInfos methods.
MonitorInfo() - Constructor for class org.dataone.service.types.v1.MonitorInfo
 
MonitorList - Class in org.dataone.service.types.v1
Schema fragment(s) for this class:
MonitorList() - Constructor for class org.dataone.service.types.v1.MonitorList
 
MultipartRequest - Class in org.dataone.mimemultipart
Wrap a HttpServletRequest and add two Map attributes to save Form Multipart files and Parameters.
MultipartRequest(HttpServletRequest, Map<String, File>, Map<String, List<String>>) - Constructor for class org.dataone.mimemultipart.MultipartRequest
Create a new MultipartParsingResult.
MultipartRequestHandler - Class in org.dataone.mimemultipart
Deprecated.
MultipartRequestHandler(String, String, HttpClient) - Constructor for class org.dataone.mimemultipart.MultipartRequestHandler
Deprecated.
constructor
MultipartRequestHandler(String, String) - Constructor for class org.dataone.mimemultipart.MultipartRequestHandler
Deprecated.
constructor
MultipartRequestResolver - Class in org.dataone.mimemultipart
DataOne conversion of HttpServletRequests into a DataONE MultipartRequest via Jakarta Commons FileUpload 1.2 or above.
MultipartRequestResolver() - Constructor for class org.dataone.mimemultipart.MultipartRequestResolver
constructor.
MultipartRequestResolver(String) - Constructor for class org.dataone.mimemultipart.MultipartRequestResolver
 
MultipartRequestResolver(String, int) - Constructor for class org.dataone.mimemultipart.MultipartRequestResolver
 
MultipartRequestResolver(String, int, int) - Constructor for class org.dataone.mimemultipart.MultipartRequestResolver
 

N

nextVersion(Identifier) - Method in class org.dataone.client.types.ObsoletesChain
 
Node - Class in org.dataone.service.types.v1
A set of values that describe a member or coordinating node, its Internet location, and the services it supports.
Node() - Constructor for class org.dataone.service.types.v1.Node
 
NodeList - Class in org.dataone.service.types.v1
A list of :class:`Types.Node` entries returned by :func:`CNCore.listNodes()`.NodeList is described in :mod:`NodeList`.
NodeList() - Constructor for class org.dataone.service.types.v1.NodeList
 
NodelistUtil - Class in org.dataone.service.types.v1.util
Convenience methods for common ways of accessing nodes and node information in the given nodelist.
NodelistUtil() - Constructor for class org.dataone.service.types.v1.util.NodelistUtil
 
NodeReference - Class in org.dataone.service.types.v1
A unique identifier for a DataONE Node.
NodeReference() - Constructor for class org.dataone.service.types.v1.NodeReference
 
NodeReplicationPolicy - Class in org.dataone.service.types.v1
The overall replication policy for the node that expresses constraints on object size, total objects, source nodes, and object format types.
NodeReplicationPolicy() - Constructor for class org.dataone.service.types.v1.NodeReplicationPolicy
 
NodeState - Enum in org.dataone.service.types.v1
An indicator of the current node accessibility.
NodeType - Enum in org.dataone.service.types.v1
The type of this node, which is either *mn* for Member Nodes, or *cn* for Coordinating Nodes.
NotAuthorized - Exception in org.dataone.service.exceptions
The DataONE NotAuthorized exception, raised when the supplied identity information is not authorized for the requested operation.
NotAuthorized(String, String) - Constructor for exception org.dataone.service.exceptions.NotAuthorized
 
NotAuthorized(String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.NotAuthorized
 
NotAuthorized(String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.NotAuthorized
 
NotAuthorized(String, String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.NotAuthorized
 
NotCached - Exception in org.dataone.client.exception
NotCached is thrown when an object is retrieved from a cache and found to not have been placed in the cache.
NotCached(String) - Constructor for exception org.dataone.client.exception.NotCached
Construct a NotCached exception with the message.
NotFound - Exception in org.dataone.service.exceptions
The DataONE NotFound exception, raised when an object is not present on the node where the exception was raised.
NotFound(String, String) - Constructor for exception org.dataone.service.exceptions.NotFound
 
NotFound(String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.NotFound
 
NotFound(String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.NotFound
 
NotFound(String, String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.NotFound
 
NotImplemented - Exception in org.dataone.service.exceptions
The DataONE NotImplemented exception, raised when a request is issued for a service that is not implemented by this node.
NotImplemented(String, String) - Constructor for exception org.dataone.service.exceptions.NotImplemented
 
NotImplemented(String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.NotImplemented
 
NotImplemented(String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.NotImplemented
 
NotImplemented(String, String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.NotImplemented
 

O

ObjectFormat - Class in org.dataone.service.types.v1
One value from the DataONE Object Format Vocabulary which is returned by :func:`CNCore.getFormat()`.An *ObjectFormat* is the structure returned from the :func:`CNCore.getFormat()` method of the CN REST interface.
ObjectFormat() - Constructor for class org.dataone.service.types.v1.ObjectFormat
 
ObjectFormatCache - Class in org.dataone.client
The ObjectFormatCache is a wrapper class for the DataONE ObjectFormatList type.
ObjectFormatIdentifier - Class in org.dataone.service.types.v1
A string used to identify an instance of :class:`Types.ObjectFormat` and MUST be unique within an instance of :class:`Types.ObjectFormatList`.
ObjectFormatIdentifier() - Constructor for class org.dataone.service.types.v1.ObjectFormatIdentifier
 
ObjectFormatInfo - Class in org.dataone.client.formats
A singleton class that provides metadata about object formats, such as the MIME type and file extensions associated with a particular format.
ObjectFormatList - Class in org.dataone.service.types.v1
An ObjectFormatList is the structure returned from the :func:`CNCore.listFormats()` method of the CN REST interface.
ObjectFormatList() - Constructor for class org.dataone.service.types.v1.ObjectFormatList
 
objectFormatList - Variable in class org.dataone.service.types.v1.util.ObjectFormatServiceImpl
 
objectFormatMap - Variable in class org.dataone.service.types.v1.util.ObjectFormatServiceImpl
 
ObjectFormatServiceImpl - Class in org.dataone.service.types.v1.util
 
ObjectFormatServiceImpl() - Constructor for class org.dataone.service.types.v1.util.ObjectFormatServiceImpl
 
ObjectInfo - Class in org.dataone.service.types.v1
Metadata about an object, representing a subset of the metadata found in :class:`Types.SystemMetadata`.
ObjectInfo() - Constructor for class org.dataone.service.types.v1.ObjectInfo
 
ObjectList - Class in org.dataone.service.types.v1
A list of object locations (nodes) from which the object can be retrieved.
ObjectList() - Constructor for class org.dataone.service.types.v1.ObjectList
 
ObjectLocation - Class in org.dataone.service.types.v1
Portion of an :class:`Types.ObjectLocationList` indicating the node from which the object can be retrieved.
ObjectLocation() - Constructor for class org.dataone.service.types.v1.ObjectLocation
 
ObjectLocationList - Class in org.dataone.service.types.v1
An *ObjectLocationList* is the structure returned from the :func:`CNRead.resolve` method of the CN REST interface.
ObjectLocationList() - Constructor for class org.dataone.service.types.v1.ObjectLocationList
 
ObsoletesChain - Class in org.dataone.client.types
An object meant to contain information on the history of an object, including all of the objects the given pid obsoletes, and objects that obsolete it.
ObsoletesChain(Identifier) - Constructor for class org.dataone.client.types.ObsoletesChain
 
org.dataone.client - package org.dataone.client
 
org.dataone.client.auth - package org.dataone.client.auth
 
org.dataone.client.cache - package org.dataone.client.cache
 
org.dataone.client.examples - package org.dataone.client.examples
 
org.dataone.client.exception - package org.dataone.client.exception
 
org.dataone.client.formats - package org.dataone.client.formats
Package org.dataone.client.formats defines a set of utility classes for accessing information about ObjectFormats that is useful in constructing nodes and clients.
org.dataone.client.types - package org.dataone.client.types
 
org.dataone.configuration - package org.dataone.configuration
 
org.dataone.eml - package org.dataone.eml
 
org.dataone.mimemultipart - package org.dataone.mimemultipart
 
org.dataone.ore - package org.dataone.ore
 
org.dataone.service.cn.v1 - package org.dataone.service.cn.v1
 
org.dataone.service.exceptions - package org.dataone.service.exceptions
 
org.dataone.service.mn.tier1.v1 - package org.dataone.service.mn.tier1.v1
 
org.dataone.service.mn.tier2.v1 - package org.dataone.service.mn.tier2.v1
 
org.dataone.service.mn.tier3.v1 - package org.dataone.service.mn.tier3.v1
 
org.dataone.service.mn.tier4.v1 - package org.dataone.service.mn.tier4.v1
 
org.dataone.service.mn.v1 - package org.dataone.service.mn.v1
 
org.dataone.service.types - package org.dataone.service.types
 
org.dataone.service.types.v1 - package org.dataone.service.types.v1
 
org.dataone.service.types.v1.comparators - package org.dataone.service.types.v1.comparators
 
org.dataone.service.types.v1.util - package org.dataone.service.types.v1.util
 
org.dataone.service.types.v1_1 - package org.dataone.service.types.v1_1
 
org.dataone.service.util - package org.dataone.service.util
 

P

parseDocument(InputStream) - Method in class org.dataone.eml.DataoneEMLParser
parse an eml document and return any distribution urls
parseResourceMap(String) - Method in class org.dataone.ore.ResourceMapFactory
Parses the string containing serialized form into the Map representation used by the org.dataone.client.DataPackage class.
parseResourceMap(InputStream) - Method in class org.dataone.ore.ResourceMapFactory
Parses the input stream from the serialized form into the Map representation used by the org.dataone.client.DataPackage class.
Permission - Enum in org.dataone.service.types.v1
A string value indicating the set of actions that can be performed on a resource as specified in an access policy.
Person - Class in org.dataone.service.types.v1
*Person* represents metadata about a :term:`Principal` that is a person and that can be used by clients and nodes for :class:`Types.AccessPolicy` information.
Person() - Constructor for class org.dataone.service.types.v1.Person
 
PersonFamilyNameComparator - Class in org.dataone.service.types.v1.comparators
A comparator for comparing the Person objects base on the family names.
PersonFamilyNameComparator() - Constructor for class org.dataone.service.types.v1.comparators.PersonFamilyNameComparator
 
ping() - Method in class org.dataone.client.CNode
ping() - Method in class org.dataone.client.D1Node
 
ping() - Method in class org.dataone.client.MNode
ping() - Method in interface org.dataone.service.cn.v1.CNCore
 
ping() - Method in interface org.dataone.service.mn.tier1.v1.MNCore
 
Ping - Class in org.dataone.service.types.v1
Store results from the :func:`MNCore.ping` method.
Ping() - Constructor for class org.dataone.service.types.v1.Ping
 
POST - Static variable in class org.dataone.service.util.Constants
HTTP Verb POST
previousVersion(Identifier) - Method in class org.dataone.client.types.ObsoletesChain
 
PUBLIC_SUBJECT - Static variable in class org.dataone.service.util.Constants
Deprecated.
PUT - Static variable in class org.dataone.service.util.Constants
HTTP Verb PUT
putData(Identifier, byte[]) - Method in class org.dataone.client.cache.LocalCache
Put an immutable data object into the local cache by serializing it as a byte array, indexed by its unique Identifier.
putSystemMetadata(Identifier, SystemMetadata) - Method in class org.dataone.client.cache.LocalCache
Put a mutable SystemMetadata object into the local cache, indexed by the unique Identifier of the object that this system metadata describes.

Q

query(String, String) - Method in class org.dataone.client.CNode
query(String, D1Url) - Method in class org.dataone.client.CNode
query(String, D1Url) - Method in class org.dataone.client.D1Node
A convenience method for building the query going to the queryEngine.
query(String, String) - Method in class org.dataone.client.D1Node
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.
query(String, String) - Method in class org.dataone.client.MNode
query(String, String) - Method in interface org.dataone.service.cn.v1.CNRead
 
query(String, String) - Method in interface org.dataone.service.mn.v1.MNQuery
 
QueryEngineDescription - Class in org.dataone.service.types.v1_1
Describes a query engine that can be used to search content on the node.
QueryEngineDescription() - Constructor for class org.dataone.service.types.v1_1.QueryEngineDescription
 
QueryEngineList - Class in org.dataone.service.types.v1_1
A list of query engine names that indicate the possible values for CNRead.getQueryEngineDescription and CNRead.query REST API endpoints.
QueryEngineList() - Constructor for class org.dataone.service.types.v1_1.QueryEngineList
 
QueryField - Class in org.dataone.service.types.v1_1
Schema fragment(s) for this class:
QueryField() - Constructor for class org.dataone.service.types.v1_1.QueryField
 

R

rc - Variable in class org.dataone.client.D1RestClient
 
recastClientSideExceptionToServiceFailure(Exception) - Static method in class org.dataone.client.D1Node
A helper function to preserve the stackTrace when catching one error and throwing a new one.
recastDataONEExceptionToServiceFailure(BaseException) - Static method in class org.dataone.client.D1Node
A helper function for recasting DataONE exceptions to ServiceFailures while preserving the detail code and TraceDetails.
refreshSystemMetadata(Integer) - Method in class org.dataone.client.D1Object
refresh the SystemMetadata of this object, first trying the CN, then the authoritative MN.
register(Node) - Method in class org.dataone.client.CNode
register(Session, Node) - Method in class org.dataone.client.CNode
register(Node) - Method in interface org.dataone.service.cn.v1.CNRegister
 
register(Session, Node) - Method in interface org.dataone.service.cn.v1.CNRegister
Deprecated.
registerAccount(Person) - Method in class org.dataone.client.CNode
registerAccount(Session, Person) - Method in class org.dataone.client.CNode
registerAccount(Person) - Method in interface org.dataone.service.cn.v1.CNIdentity
 
registerAccount(Session, Person) - Method in interface org.dataone.service.cn.v1.CNIdentity
Deprecated.
registerCertificate(String, X509Certificate, PrivateKey) - Method in class org.dataone.client.auth.CertificateManager
Register certificates to be used by getSSLSocjetFactory(subject) for setting up connections, using the subject as the lookup key
registerSystemMetadata(Identifier, SystemMetadata) - Method in class org.dataone.client.CNode
registerSystemMetadata(Session, Identifier, SystemMetadata) - Method in class org.dataone.client.CNode
registerSystemMetadata(Identifier, SystemMetadata) - Method in interface org.dataone.service.cn.v1.CNCore
 
registerSystemMetadata(Session, Identifier, SystemMetadata) - Method in interface org.dataone.service.cn.v1.CNCore
Deprecated.
reload() - Static method in class org.dataone.client.formats.ObjectFormatInfo
Cause the ObjectFormatInfo to reload its data, which enables a calling application to programatically modify the underlying mapping data and then reload the mappings in this class for use without restarting the application.
remove(Identifier) - Method in class org.dataone.client.DataPackage
Deprecated.
renaming to removeData(Identifier id) for naming consistency with addData, addAndDownloadData
removeAccess(Subject[]) - Method in class org.dataone.client.AccessPolicyEditor
Removes the specified Subjects from the AccessPolicy
removeAttribute(String) - Method in class org.dataone.mimemultipart.MultipartRequest
 
removeData(Identifier) - Method in class org.dataone.client.DataPackage
Removes a D1Object from the local data store based on its Identifier.
removeMapIdentity(Subject) - Method in class org.dataone.client.CNode
removeMapIdentity(Session, Subject) - Method in class org.dataone.client.CNode
removeMapIdentity(Subject) - Method in interface org.dataone.service.cn.v1.CNIdentity
 
removeMapIdentity(Session, Subject) - Method in interface org.dataone.service.cn.v1.CNIdentity
Deprecated.
Replica - Class in org.dataone.service.types.v1
Replica information that describes the existence of a replica of some object managed by the DataONE infrastructure, and its status.
Replica() - Constructor for class org.dataone.service.types.v1.Replica
 
replicate(SystemMetadata, NodeReference) - Method in class org.dataone.client.MNode
replicate(Session, SystemMetadata, NodeReference) - Method in class org.dataone.client.MNode
replicate(SystemMetadata, NodeReference) - Method in interface org.dataone.service.mn.tier4.v1.MNReplication
 
replicate(Session, SystemMetadata, NodeReference) - Method in interface org.dataone.service.mn.tier4.v1.MNReplication
Deprecated.
ReplicationPolicy - Class in org.dataone.service.types.v1
The *ReplicationPolicy* for an object defines if replication should be attempted for this object, and if so, how many replicas should be maintained.
ReplicationPolicy() - Constructor for class org.dataone.service.types.v1.ReplicationPolicy
 
ReplicationStatus - Enum in org.dataone.service.types.v1
An enumerated string value indicating the current state of a replica of an object.
reportSubtypesListing(Object, Boolean) - Static method in class org.dataone.service.types.TypeCompareUtil
Generates a tabular listing of the field names and values, suitable for display.
requestMapIdentity(Subject) - Method in class org.dataone.client.CNode
requestMapIdentity(Session, Subject) - Method in class org.dataone.client.CNode
requestMapIdentity(Subject) - Method in interface org.dataone.service.cn.v1.CNIdentity
 
requestMapIdentity(Session, Subject) - Method in interface org.dataone.service.cn.v1.CNIdentity
Deprecated.
reserveIdentifier(Identifier) - Method in class org.dataone.client.CNode
reserveIdentifier(Session, Identifier) - Method in class org.dataone.client.CNode
reserveIdentifier(Identifier) - Method in interface org.dataone.service.cn.v1.CNCore
 
reserveIdentifier(Session, Identifier) - Method in interface org.dataone.service.cn.v1.CNCore
Deprecated.
resetCounters() - Method in class org.dataone.client.cache.LocalCache
Reset the cache hit/miss counters to 0.
resolve(Identifier) - Method in class org.dataone.client.CNode
resolve(Session, Identifier) - Method in class org.dataone.client.CNode
resolve(Identifier) - Method in interface org.dataone.service.cn.v1.CNRead
 
resolve(Session, Identifier) - Method in interface org.dataone.service.cn.v1.CNRead
Deprecated.
resolveMultipart(HttpServletRequest) - Method in class org.dataone.mimemultipart.MultipartRequestResolver
get the parts of a
RESOURCE_ACCESS - Static variable in class org.dataone.service.util.Constants
AUTHORIZATION API resource which handles access operations
RESOURCE_ACCOUNT_MAPPING - Static variable in class org.dataone.service.util.Constants
IDENTITY API resource which handles account-mapping operations
RESOURCE_ACCOUNT_MAPPING_PENDING - Static variable in class org.dataone.service.util.Constants
IDENTITY API resource which handles account-mapping request operations
RESOURCE_ACCOUNT_VERIFICATION - Static variable in class org.dataone.service.util.Constants
IDENTITY API resource which handles account-verification request operations
RESOURCE_ACCOUNTS - Static variable in class org.dataone.service.util.Constants
IDENTITY API resource which handles account operations
RESOURCE_ARCHIVE - Static variable in class org.dataone.service.util.Constants
Common API resource which handles archive operations
RESOURCE_AUTHORIZATION - Static variable in class org.dataone.service.util.Constants
AUTHORIZATION API Resource which handles authorization checks
RESOURCE_CHECKSUM - Static variable in class org.dataone.service.util.Constants
READ API resource which handles checksum operations
RESOURCE_ERROR - Static variable in class org.dataone.service.util.Constants
READ API resource which handles synchronization error operations
RESOURCE_FORMATS - Static variable in class org.dataone.service.util.Constants
CORE API Resource which handles object formats operations
RESOURCE_GENERATE - Static variable in class org.dataone.service.util.Constants
CORE API resource which handles identifier generation operations
RESOURCE_GROUPS - Static variable in class org.dataone.service.util.Constants
IDENTITY API resource which handles group-related operations
RESOURCE_GROUPS_REMOVE - Static variable in class org.dataone.service.util.Constants
IDENTITY API resource which handles group-member-remove operations
RESOURCE_LOG - Static variable in class org.dataone.service.util.Constants
CORE API resource which handles logging operations
RESOURCE_META - Static variable in class org.dataone.service.util.Constants
Common API resource which handles SystemMetadata operations
RESOURCE_META_CHANGED - Static variable in class org.dataone.service.util.Constants
Common API resource which handles SystemMetadata update operations
RESOURCE_META_OBSOLETEDBY - Static variable in class org.dataone.service.util.Constants
Common API resource which handles SystemMetadata update operations
RESOURCE_MONITOR_EVENT - Static variable in class org.dataone.service.util.Constants
CORE API resource which handles event monitoring operations
RESOURCE_MONITOR_OBJECT - Static variable in class org.dataone.service.util.Constants
CORE API resource which handles object monitoring operations
RESOURCE_MONITOR_PING - Static variable in class org.dataone.service.util.Constants
CORE API resource which handles ping monitoring operations
RESOURCE_MONITOR_STATUS - Static variable in class org.dataone.service.util.Constants
CORE API resource which handles status monitoring operations
RESOURCE_NODE - Static variable in class org.dataone.service.util.Constants
Common API resource which handles node operations
RESOURCE_OBJECTS - Static variable in class org.dataone.service.util.Constants
Common API resource which handles document operations
RESOURCE_OWNER - Static variable in class org.dataone.service.util.Constants
AUTHORIZATION API Resource which handles owner checks
RESOURCE_QUERY - Static variable in class org.dataone.service.util.Constants
Common API resource which handles query operations
RESOURCE_RELATIONSHIP - Static variable in class org.dataone.service.util.Constants
READ API resource which handles relationship assertion operations
RESOURCE_REPLICAS - Static variable in class org.dataone.service.util.Constants
REPLICATION API endpoint representing the replicas collection
RESOURCE_REPLICATE - Static variable in class org.dataone.service.util.Constants
REPLICATION API endpoint that represents replication initiation
RESOURCE_REPLICATION_AUTHORIZED - Static variable in class org.dataone.service.util.Constants
REPLICATION API endpoint that represents replication authorization
RESOURCE_REPLICATION_DELETE_REPLICA - Static variable in class org.dataone.service.util.Constants
REPLICATION API endpoint that represents replica deletes
RESOURCE_REPLICATION_META - Static variable in class org.dataone.service.util.Constants
REPLICATION API endpoint that represents replication metadata updates
RESOURCE_REPLICATION_NOTIFY - Static variable in class org.dataone.service.util.Constants
REPLICATION API endpoint that represents replication status updates
RESOURCE_REPLICATION_POLICY - Static variable in class org.dataone.service.util.Constants
REPLICATION API endpoint that represents replication policy updates
RESOURCE_RESERVE - Static variable in class org.dataone.service.util.Constants
CORE API resource which handles identifier reserving operations
RESOURCE_RESOLVE - Static variable in class org.dataone.service.util.Constants
READ API resource which handles resolve operations
RESOURCE_SEARCH - Static variable in class org.dataone.service.util.Constants
Common API resource which handles search operations
ResourceMapFactory - Class in org.dataone.ore
A utility for serializing and deserializing Resource Maps used by DataONE, following the conventions and constraints detailed in http://mule1.dataone.org/ArchitectureDocs-current/design/DataPackage.html Note: DataONE uses the serialized form of ResourceMaps to persist the relationships between metadata objects and the data objects they document, and builds a ResourceMap as an intermediate form to derive the relationships into a simpler "identifier map" representation.
RestClient - Class in org.dataone.client
A generic client class that contains base functionality for making REST calls to remote REST servers.
RestClient() - Constructor for class org.dataone.client.RestClient
Default constructor to create a new instance.
RestClient(AbstractHttpClient) - Constructor for class org.dataone.client.RestClient
 

S

Schedule - Class in org.dataone.service.types.v1
The schedule on which :term:`synchronization` will run for a particular node.
Schedule() - Constructor for class org.dataone.service.types.v1.Schedule
 
search(String, D1Url) - Method in class org.dataone.client.CNode
A convenience method for creating a search command utilizing the D1Url class for building the value for the query parameter.
search(Session, String, D1Url) - Method in class org.dataone.client.CNode
A convenience method for creating a search command utilizing the D1Url class for building the value for the query parameter.
search(String, String) - Method in class org.dataone.client.CNode
see DataONE API Reference This implementation handles URL-escaping for only the "queryType" parameter, and always places a slash ('/') character after it.
search(Session, String, String) - Method in class org.dataone.client.CNode
see DataONE API Reference This implementation handles URL-escaping for only the "queryType" parameter, and always places a slash ('/') character after it.
search(String, String) - Method in interface org.dataone.service.cn.v1.CNRead
 
search(Session, String, String) - Method in interface org.dataone.service.cn.v1.CNRead
Deprecated.
selectNode(NodeList, Subject) - Static method in class org.dataone.service.types.v1.util.NodelistUtil
Finds the nodes in the NodeList that contain the provided Subject.
selectNodes(NodeList, NodeType) - Static method in class org.dataone.service.types.v1.util.NodelistUtil
Finds the nodes in the NodeList that match the provided NodeType.
selectNodes(NodeList, NodeState) - Static method in class org.dataone.service.types.v1.util.NodelistUtil
Finds the nodes in the NodeList that are in the provided state.
selectNodesByService(NodeList, String, String, boolean) - Static method in class org.dataone.service.types.v1.util.NodelistUtil
Finds the nodes in the NodeList that contain services that match the provided serviceName and availability.
serialize(int) - Method in exception org.dataone.service.exceptions.BaseException
Serialize the format in XML, JSON, or HTML format.
serializeBigInteger(BigInteger) - Static method in class org.dataone.service.util.BigIntegerMarshaller
 
serializeDateToUTC(Date) - Static method in class org.dataone.service.util.DateTimeMarshaller
convert a date to GMT
serializePackage() - Method in class org.dataone.client.DataPackage
Return an ORE ResourceMap describing this package, serialized as an RDF graph.
serializeResourceMap(ResourceMap) - Method in class org.dataone.ore.ResourceMapFactory
Serialize the ResourceMap
Service - Class in org.dataone.service.types.v1
The available Dataone Service APIs that are exposed on a Node.
Service() - Constructor for class org.dataone.service.types.v1.Service
 
SERVICE_VERSION - Static variable in interface org.dataone.service.cn.v1.CNCore
 
SERVICE_VERSION - Static variable in interface org.dataone.service.mn.tier1.v1.MNCore
 
ServiceFailure - Exception in org.dataone.service.exceptions
The DataONE ServiceFailure exception, raised when a requested service was called but failed to execute the service request due to an internal error, such as misconfiguration, or a missing resource such as a missing data connection, etc.
ServiceFailure(String, String) - Constructor for exception org.dataone.service.exceptions.ServiceFailure
 
ServiceFailure(String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.ServiceFailure
 
ServiceFailure(String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.ServiceFailure
 
ServiceFailure(String, String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.ServiceFailure
 
ServiceMethodRestriction - Class in org.dataone.service.types.v1
Describes an optional restriction policy for a given method.
ServiceMethodRestriction() - Constructor for class org.dataone.service.types.v1.ServiceMethodRestriction
 
ServiceMethodRestrictionUtil - Class in org.dataone.service.types.v1.util
Methods for interpreting ServiceMethodRestriction rules
ServiceMethodRestrictionUtil() - Constructor for class org.dataone.service.types.v1.util.ServiceMethodRestrictionUtil
 
Services - Class in org.dataone.service.types.v1
A list of services that are provided by a node.
Services() - Constructor for class org.dataone.service.types.v1.Services
 
session - Variable in class org.dataone.client.D1Node
this represents the session to be used for establishing the SSL connection
Session - Class in org.dataone.service.types.v1
Information about the authenticated session for a service transaction.
Session() - Constructor for class org.dataone.service.types.v1.Session
 
setAccess(Subject[], Permission) - Method in class org.dataone.client.AccessPolicyEditor
 
setAccessPolicy(Identifier, AccessPolicy, long) - Method in class org.dataone.client.CNode
setAccessPolicy(Session, Identifier, AccessPolicy, long) - Method in class org.dataone.client.CNode
setAccessPolicy(Identifier, AccessPolicy, long) - Method in interface org.dataone.service.cn.v1.CNAuthorization
 
setAccessPolicy(Session, Identifier, AccessPolicy, long) - Method in interface org.dataone.service.cn.v1.CNAuthorization
Deprecated.
setAccessPolicy(AccessPolicy) - Method in class org.dataone.service.types.v1.SystemMetadata
Set the 'accessPolicy' element value.
setAdditionalInfoList(List<String>) - Method in class org.dataone.service.types.v1_1.QueryEngineDescription
Set the list of 'additionalInfo' element items.
setAlgorithm(String) - Method in class org.dataone.service.types.v1.Checksum
Set the 'algorithm' attribute value.
setAlgorithmList(List<String>) - Method in class org.dataone.service.types.v1.ChecksumAlgorithmList
Set the list of 'algorithm' element items.
setAllowedNodeList(List<NodeReference>) - Method in class org.dataone.service.types.v1.NodeReplicationPolicy
Set the list of 'allowedNode' element items.
setAllowedObjectFormatList(List<ObjectFormatIdentifier>) - Method in class org.dataone.service.types.v1.NodeReplicationPolicy
Set the list of 'allowedObjectFormat' element items.
setAllowList(List<AccessRule>) - Method in class org.dataone.service.types.v1.AccessPolicy
Set the list of 'allow' element items.
setArchived(Boolean) - Method in class org.dataone.service.types.v1.SystemMetadata
Set the 'archived' element value.
setAttribute(String, Object) - Method in class org.dataone.mimemultipart.MultipartRequest
 
setAuthoritativeMemberNode(NodeReference) - Method in class org.dataone.service.types.v1.SystemMetadata
Set the 'authoritativeMemberNode' element value.
setAvailable(Boolean) - Method in class org.dataone.service.types.v1.Service
Set the 'available' attribute value.
setBaseURL(String) - Method in class org.dataone.service.types.v1.Node
Set the 'baseURL' element value.
setBaseURL(String) - Method in class org.dataone.service.types.v1.ObjectLocation
Set the 'baseURL' element value.
setBaseUrl(String) - Method in class org.dataone.service.util.D1Url
 
setBlockedMemberNodeList(List<NodeReference>) - Method in class org.dataone.service.types.v1.ReplicationPolicy
Set the list of 'blockedMemberNode' element items.
setCertificateLocation(String) - Method in class org.dataone.client.auth.CertificateManager
Use this method to set the certificate to point CertificateManager to a certificate at the designated file-path.
setCharacterEncoding(String) - Method in class org.dataone.mimemultipart.MultipartRequest
 
setChecksum(Checksum) - Method in class org.dataone.service.types.v1.ObjectInfo
Set the 'checksum' element value.
setChecksum(Checksum) - Method in class org.dataone.service.types.v1.SystemMetadata
Set the 'checksum' element value.
setCode(int) - Method in exception org.dataone.service.exceptions.BaseException
 
setContactSubjectList(List<Subject>) - Method in class org.dataone.service.types.v1.Node
Set the list of 'contactSubject' element items.
setCount(int) - Method in class org.dataone.service.types.v1.MonitorInfo
Set the 'count' element value.
setCount(int) - Method in class org.dataone.service.types.v1.Slice
Set the 'count' attribute value.
setCurrentIdentity(String) - Static method in class org.dataone.client.auth.ClientIdentityManager
uses the value of the property passed to setup the CertificateManager to use the certificate found at that path
setData(byte[]) - Method in class org.dataone.client.D1Object
Deprecated. 
setDataSource(DataSource) - Method in class org.dataone.client.D1Object
set the DataSource representation of the data
setDate(Date) - Method in class org.dataone.service.types.v1.MonitorInfo
Set the 'date' element value.
setDateLogged(Date) - Method in class org.dataone.service.types.v1.LogEntry
Set the 'dateLogged' element value.
setDateSysMetadataModified(Date) - Method in class org.dataone.service.types.v1.ObjectInfo
Set the 'dateSysMetadataModified' element value.
setDateSysMetadataModified(Date) - Method in class org.dataone.service.types.v1.SystemMetadata
Set the 'dateSysMetadataModified' element value.
setDateUploaded(Date) - Method in class org.dataone.service.types.v1.SystemMetadata
Set the 'dateUploaded' element value.
setDefaultSoTimeout(Integer) - Method in class org.dataone.client.D1Node
 
setDescription(String) - Method in class org.dataone.service.types.v1.Node
Set the 'description' element value.
setDescriptionList(List<String>) - Method in class org.dataone.service.types.v1_1.QueryField
Set the list of 'description' element items.
setDetail_code(String) - Method in exception org.dataone.service.exceptions.BaseException
 
setEmailList(List<String>) - Method in class org.dataone.service.types.v1.Person
Set the list of 'email' element items.
setEntryId(String) - Method in class org.dataone.service.types.v1.LogEntry
Set the 'entryId' element value.
setEquivalentIdentityList(List<Subject>) - Method in class org.dataone.service.types.v1.Person
Set the list of 'equivalentIdentity' element items.
setEvent(Event) - Method in class org.dataone.service.types.v1.LogEntry
Set the 'event' element value.
setFamilyName(String) - Method in class org.dataone.service.types.v1.Person
Set the 'familyName' element value.
setFormatId(ObjectFormatIdentifier) - Method in class org.dataone.service.types.v1.ObjectFormat
Set the 'formatId' element value.
setFormatId(ObjectFormatIdentifier) - Method in class org.dataone.service.types.v1.ObjectInfo
Set the 'formatId' element value.
setFormatId(ObjectFormatIdentifier) - Method in class org.dataone.service.types.v1.SystemMetadata
Set the 'formatId' element value.
setFormatName(String) - Method in class org.dataone.service.types.v1.ObjectFormat
Set the 'formatName' element value.
setFormatType(String) - Method in class org.dataone.service.types.v1.ObjectFormat
Set the 'formatType' element value.
setGivenNameList(List<String>) - Method in class org.dataone.service.types.v1.Person
Set the list of 'givenName' element items.
setGroupList(List<Group>) - Method in class org.dataone.service.types.v1.SubjectInfo
Set the list of 'group' element items.
setGroupName(String) - Method in class org.dataone.service.types.v1.Group
Set the 'groupName' element value.
setHasMemberList(List<Subject>) - Method in class org.dataone.service.types.v1.Group
Set the list of 'hasMember' element items.
setHeader(String, String) - Method in class org.dataone.client.D1RestClient
 
setHeader(String, String) - Method in class org.dataone.client.RestClient
adds headers with the provided key and value to the RestClient instance to be used for subsequent calls
setHour(String) - Method in class org.dataone.service.types.v1.Schedule
Set the 'hour' attribute value.
setHttpClient(AbstractHttpClient) - Method in class org.dataone.client.RestClient
Sets the AbstractHttpClient instance used for the connection.
setHttpClient(HttpClient) - Method in class org.dataone.mimemultipart.MultipartRequestHandler
Deprecated.
replace the DefaultHttpClient created at time of instantiation with the specified one.
setIdentifier(Identifier) - Method in class org.dataone.service.types.v1.LogEntry
Set the 'identifier' element value.
setIdentifier(NodeReference) - Method in class org.dataone.service.types.v1.Node
Set the 'identifier' element value.
setIdentifier(Identifier) - Method in class org.dataone.service.types.v1.ObjectInfo
Set the 'identifier' element value.
setIdentifier(Identifier) - Method in class org.dataone.service.types.v1.ObjectLocationList
Set the 'identifier' element value.
setIdentifier(Identifier) - Method in class org.dataone.service.types.v1.SystemMetadata
Set the 'identifier' element value.
setIpAddress(String) - Method in class org.dataone.service.types.v1.LogEntry
Set the 'ipAddress' element value.
setIsMemberOfList(List<Subject>) - Method in class org.dataone.service.types.v1.Person
Set the list of 'isMemberOf' element items.
setLastCompleteHarvest(Date) - Method in class org.dataone.service.types.v1.Synchronization
Set the 'lastCompleteHarvest' element value.
setLastHarvested(Date) - Method in class org.dataone.service.types.v1.Synchronization
Set the 'lastHarvested' element value.
setLastSuccess(Date) - Method in class org.dataone.service.types.v1.Ping
Set the 'lastSuccess' attribute value.
setLatestRequestUrl(String) - Method in class org.dataone.client.D1Node
 
setLogEntryList(List<LogEntry>) - Method in class org.dataone.service.types.v1.Log
Set the list of 'logEntry' element items.
setMaxObjectSize(BigInteger) - Method in class org.dataone.service.types.v1.NodeReplicationPolicy
Set the 'maxObjectSize' element value.
setMday(String) - Method in class org.dataone.service.types.v1.Schedule
Set the 'mday' attribute value.
setMetadataMap(Map<Identifier, List<Identifier>>) - Method in class org.dataone.client.DataPackage
 
setMethodName(String) - Method in class org.dataone.service.types.v1.ServiceMethodRestriction
Set the 'methodName' attribute value.
setMin(String) - Method in class org.dataone.service.types.v1.Schedule
Set the 'min' attribute value.
setMon(String) - Method in class org.dataone.service.types.v1.Schedule
Set the 'mon' attribute value.
setMonitorInfoList(List<MonitorInfo>) - Method in class org.dataone.service.types.v1.MonitorList
Set the list of 'monitorInfo' element items.
setMultivalued(Boolean) - Method in class org.dataone.service.types.v1_1.QueryField
Set the 'multivalued' element value.
setName(String) - Method in class org.dataone.service.types.v1.Node
Set the 'name' element value.
setName(String) - Method in class org.dataone.service.types.v1.Service
Set the 'name' attribute value.
setName(String) - Method in class org.dataone.service.types.v1_1.QueryEngineDescription
Set the 'name' element value.
setName(String) - Method in class org.dataone.service.types.v1_1.QueryField
Set the 'name' element value.
setNodeBaseServiceUrl(String) - Method in class org.dataone.client.D1Node
Set the service URL for this node.
setNodeId(String) - Method in class org.dataone.client.D1Node
 
setNodeId(String) - Method in exception org.dataone.service.exceptions.BaseException
Set the node Id string
setNodeIdentifier(NodeReference) - Method in class org.dataone.service.types.v1.LogEntry
Set the 'nodeIdentifier' element value.
setNodeIdentifier(NodeReference) - Method in class org.dataone.service.types.v1.ObjectLocation
Set the 'nodeIdentifier' element value.
setNodeList(List<Node>) - Method in class org.dataone.service.types.v1.NodeList
Set the list of 'node' element items.
setNodeReplicationPolicy(NodeReplicationPolicy) - Method in class org.dataone.service.types.v1.Node
Set the 'nodeReplicationPolicy' element value.
setNumberReplicas(Integer) - Method in class org.dataone.service.types.v1.ReplicationPolicy
Set the 'numberReplicas' attribute value.
setObjectFormat(ObjectFormat) - Method in class org.dataone.eml.EMLDocument
set the format of the document
setObjectFormatList(List<ObjectFormat>) - Method in class org.dataone.service.types.v1.ObjectFormatList
Set the list of 'objectFormat' element items.
setObjectInfoList(List<ObjectInfo>) - Method in class org.dataone.service.types.v1.ObjectList
Set the list of 'objectInfo' element items.
setObjectLocationList(List<ObjectLocation>) - Method in class org.dataone.service.types.v1.ObjectLocationList
Set the list of 'objectLocation' element items.
setObsoletedBy(Identifier, Identifier, long) - Method in class org.dataone.client.CNode
setObsoletedBy(Session, Identifier, Identifier, long) - Method in class org.dataone.client.CNode
setObsoletedBy(Identifier, Identifier, long) - Method in interface org.dataone.service.cn.v1.CNCore
 
setObsoletedBy(Session, Identifier, Identifier, long) - Method in interface org.dataone.service.cn.v1.CNCore
Deprecated.
setObsoletedBy(Identifier) - Method in class org.dataone.service.types.v1.SystemMetadata
Set the 'obsoletedBy' element value.
setObsoletes(Identifier) - Method in class org.dataone.service.types.v1.SystemMetadata
Set the 'obsoletes' element value.
setOriginMemberNode(NodeReference) - Method in class org.dataone.service.types.v1.SystemMetadata
Set the 'originMemberNode' element value.
setPackageId(Identifier) - Method in class org.dataone.client.DataPackage
 
setPermissionList(List<Permission>) - Method in class org.dataone.service.types.v1.AccessRule
Set the list of 'permission' element items.
setPersonList(List<Person>) - Method in class org.dataone.service.types.v1.SubjectInfo
Set the list of 'person' element items.
setPid(String) - Method in exception org.dataone.service.exceptions.BaseException
 
setPing(Ping) - Method in class org.dataone.service.types.v1.Node
Set the 'ping' element value.
setPreference(Integer) - Method in class org.dataone.service.types.v1.ObjectLocation
Set the 'preference' element value.
setPreferredMemberNodeList(List<NodeReference>) - Method in class org.dataone.service.types.v1.ReplicationPolicy
Set the list of 'preferredMemberNode' element items.
setPublicAccess() - Method in class org.dataone.client.AccessPolicyEditor
 
setPublicAccess(Session) - Method in class org.dataone.client.D1Object
Change the object to publicly readable
setQueryEngineList(List<String>) - Method in class org.dataone.service.types.v1_1.QueryEngineList
Set the list of 'queryEngine' element items.
setQueryEngineVersion(String) - Method in class org.dataone.service.types.v1_1.QueryEngineDescription
Set the 'queryEngineVersion' element value.
setQueryFieldList(List<QueryField>) - Method in class org.dataone.service.types.v1_1.QueryEngineDescription
Set the list of 'queryField' element items.
setQuerySchemaVersion(String) - Method in class org.dataone.service.types.v1_1.QueryEngineDescription
Set the 'querySchemaVersion' element value.
setReplicaList(List<Replica>) - Method in class org.dataone.service.types.v1.SystemMetadata
Set the list of 'replica' element items.
setReplicaMemberNode(NodeReference) - Method in class org.dataone.service.types.v1.Replica
Set the 'replicaMemberNode' element value.
setReplicate(boolean) - Method in class org.dataone.service.types.v1.Node
Set the 'replicate' attribute value.
setReplicationAllowed(Boolean) - Method in class org.dataone.service.types.v1.ReplicationPolicy
Set the 'replicationAllowed' attribute value.
setReplicationPolicy(Identifier, ReplicationPolicy, long) - Method in class org.dataone.client.CNode
setReplicationPolicy(Session, Identifier, ReplicationPolicy, long) - Method in class org.dataone.client.CNode
setReplicationPolicy(Identifier, ReplicationPolicy, long) - Method in interface org.dataone.service.cn.v1.CNReplication
 
setReplicationPolicy(Session, Identifier, ReplicationPolicy, long) - Method in interface org.dataone.service.cn.v1.CNReplication
Deprecated.
setReplicationPolicy(ReplicationPolicy) - Method in class org.dataone.service.types.v1.SystemMetadata
Set the 'replicationPolicy' element value.
setReplicationStatus(Identifier, NodeReference, ReplicationStatus, BaseException) - Method in class org.dataone.client.CNode
setReplicationStatus(Session, Identifier, NodeReference, ReplicationStatus, BaseException) - Method in class org.dataone.client.CNode
setReplicationStatus(Identifier, NodeReference, ReplicationStatus, BaseException) - Method in interface org.dataone.service.cn.v1.CNReplication
 
setReplicationStatus(Session, Identifier, NodeReference, ReplicationStatus, BaseException) - Method in interface org.dataone.service.cn.v1.CNReplication
Deprecated.
setReplicationStatus(ReplicationStatus) - Method in class org.dataone.service.types.v1.Replica
Set the 'replicationStatus' element value.
setReplicaVerified(Date) - Method in class org.dataone.service.types.v1.Replica
Set the 'replicaVerified' element value.
setResource(String) - Method in class org.dataone.service.util.D1Url
 
setRestrictionList(List<ServiceMethodRestriction>) - Method in class org.dataone.service.types.v1.Service
Set the list of 'restriction' element items.
setReturnable(boolean) - Method in class org.dataone.service.types.v1_1.QueryField
Set the 'returnable' element value.
setRightsHolder(Identifier, Subject, long) - Method in class org.dataone.client.CNode
setRightsHolder(Session, Identifier, Subject, long) - Method in class org.dataone.client.CNode
setRightsHolder(Identifier, Subject, long) - Method in interface org.dataone.service.cn.v1.CNAuthorization
 
setRightsHolder(Session, Identifier, Subject, long) - Method in interface org.dataone.service.cn.v1.CNAuthorization
Deprecated.
setRightsHolder(Subject) - Method in class org.dataone.service.types.v1.SystemMetadata
Set the 'rightsHolder' element value.
setRightsHolderList(List<Subject>) - Method in class org.dataone.service.types.v1.Group
Set the list of 'rightsHolder' element items.
setSchedule(Schedule) - Method in class org.dataone.service.types.v1.Synchronization
Set the 'schedule' element value.
setSearchable(boolean) - Method in class org.dataone.service.types.v1_1.QueryField
Set the 'searchable' element value.
setSec(String) - Method in class org.dataone.service.types.v1.Schedule
Set the 'sec' attribute value.
setSerialVersion(BigInteger) - Method in class org.dataone.service.types.v1.SystemMetadata
Set the 'serialVersion' element value.
setServiceList(List<Service>) - Method in class org.dataone.service.types.v1.Services
Set the list of 'service' element items.
setServices(Services) - Method in class org.dataone.service.types.v1.Node
Set the 'services' element value.
setSize(BigInteger) - Method in class org.dataone.service.types.v1.ObjectInfo
Set the 'size' element value.
setSize(BigInteger) - Method in class org.dataone.service.types.v1.SystemMetadata
Set the 'size' element value.
setSortable(boolean) - Method in class org.dataone.service.types.v1_1.QueryField
Set the 'sortable' element value.
setSpaceAllocated(BigInteger) - Method in class org.dataone.service.types.v1.NodeReplicationPolicy
Set the 'spaceAllocated' element value.
setStart(int) - Method in class org.dataone.service.types.v1.Slice
Set the 'start' attribute value.
setState(NodeState) - Method in class org.dataone.service.types.v1.Node
Set the 'state' attribute value.
setSubject(Subject) - Method in class org.dataone.service.types.v1.Group
Set the 'subject' element value.
setSubject(Subject) - Method in class org.dataone.service.types.v1.LogEntry
Set the 'subject' element value.
setSubject(Subject) - Method in class org.dataone.service.types.v1.Person
Set the 'subject' element value.
setSubject(Subject) - Method in class org.dataone.service.types.v1.Session
Set the 'subject' element value.
setSubjectInfo(SubjectInfo) - Method in class org.dataone.service.types.v1.Session
Set the 'subjectInfo' element value.
setSubjectList(List<Subject>) - Method in class org.dataone.service.types.v1.AccessRule
Set the list of 'subject' element items.
setSubjectList(List<Subject>) - Method in class org.dataone.service.types.v1.Node
Set the list of 'subject' element items.
setSubjectList(List<Subject>) - Method in class org.dataone.service.types.v1.SubjectList
Set the list of 'subject' element items.
setSubmitter(Subject) - Method in class org.dataone.service.types.v1.SystemMetadata
Set the 'submitter' element value.
setSuccess(Boolean) - Method in class org.dataone.service.types.v1.Ping
Set the 'success' attribute value.
setSynchronization(Synchronization) - Method in class org.dataone.service.types.v1.Node
Set the 'synchronization' element value.
setSynchronize(boolean) - Method in class org.dataone.service.types.v1.Node
Set the 'synchronize' attribute value.
setSystemMetadata(SystemMetadata) - Method in class org.dataone.client.D1Object
 
setSystemMetadata(SystemMetadata) - Method in class org.dataone.client.DataPackage
Set the SystemMetadata object to this data package.
setTimeouts(int) - Method in class org.dataone.client.D1RestClient
Sets the CONNECTION_TIMEOUT and SO_TIMEOUT values for the underlying httpClient.
setTimeouts(int) - Method in class org.dataone.client.RestClient
Sets the CONNECTION_TIMEOUT and SO_TIMEOUT values for the underlying httpClient.
Settings - Class in org.dataone.configuration
 
setTotal(int) - Method in class org.dataone.service.types.v1.Slice
Set the 'total' attribute value.
setType(NodeType) - Method in class org.dataone.service.types.v1.Node
Set the 'type' attribute value.
setType(String) - Method in class org.dataone.service.types.v1_1.QueryField
Set the 'type' element value.
setupSSL(Session) - Method in class org.dataone.client.D1RestClient
Method used by the constructors to setup the connection with SSL.
setUrl(String) - Method in class org.dataone.service.types.v1.ObjectLocation
Set the 'url' element value.
setUserAgent(String) - Method in class org.dataone.service.types.v1.LogEntry
Set the 'userAgent' element value.
setValue(String) - Method in class org.dataone.service.types.v1.Checksum
Set the extension value.
setValue(String) - Method in class org.dataone.service.types.v1.Identifier
Set the 'Identifier' complexType value.
setValue(String) - Method in class org.dataone.service.types.v1.NodeReference
Set the 'NodeReference' complexType value.
setValue(String) - Method in class org.dataone.service.types.v1.ObjectFormatIdentifier
Set the 'ObjectFormatIdentifier' simpleType value.
setValue(String) - Method in class org.dataone.service.types.v1.Subject
Set the 'Subject' complexType value.
setVerified(Boolean) - Method in class org.dataone.service.types.v1.Person
Set the 'verified' element value.
setVersion(String) - Method in class org.dataone.service.types.v1.Service
Set the 'version' attribute value.
setVersionList(List<String>) - Method in class org.dataone.service.types.v1.ObjectLocation
Set the list of 'version' element items.
setWday(String) - Method in class org.dataone.service.types.v1.Schedule
Set the 'wday' attribute value.
setYear(String) - Method in class org.dataone.service.types.v1.Schedule
Set the 'year' attribute value.
SimpleMultipartEntity - Class in org.dataone.mimemultipart
 
SimpleMultipartEntity() - Constructor for class org.dataone.mimemultipart.SimpleMultipartEntity
 
size() - Method in class org.dataone.client.DataPackage
Used to introspect on the local temporary data store, NOT the number of DataPackage members.
size() - Method in class org.dataone.client.types.ObsoletesChain
returns the size of the chain (count of the number of items)
sizeAdditionalInfoList() - Method in class org.dataone.service.types.v1_1.QueryEngineDescription
Get the number of 'additionalInfo' element items.
sizeAlgorithmList() - Method in class org.dataone.service.types.v1.ChecksumAlgorithmList
Get the number of 'algorithm' element items.
sizeAllowedNodeList() - Method in class org.dataone.service.types.v1.NodeReplicationPolicy
Get the number of 'allowedNode' element items.
sizeAllowedObjectFormatList() - Method in class org.dataone.service.types.v1.NodeReplicationPolicy
Get the number of 'allowedObjectFormat' element items.
sizeAllowList() - Method in class org.dataone.service.types.v1.AccessPolicy
Get the number of 'allow' element items.
sizeBlockedMemberNodeList() - Method in class org.dataone.service.types.v1.ReplicationPolicy
Get the number of 'blockedMemberNode' element items.
sizeContactSubjectList() - Method in class org.dataone.service.types.v1.Node
Get the number of 'contactSubject' element items.
sizeDescriptionList() - Method in class org.dataone.service.types.v1_1.QueryField
Get the number of 'description' element items.
sizeEmailList() - Method in class org.dataone.service.types.v1.Person
Get the number of 'email' element items.
sizeEquivalentIdentityList() - Method in class org.dataone.service.types.v1.Person
Get the number of 'equivalentIdentity' element items.
sizeGivenNameList() - Method in class org.dataone.service.types.v1.Person
Get the number of 'givenName' element items.
sizeGroupList() - Method in class org.dataone.service.types.v1.SubjectInfo
Get the number of 'group' element items.
sizeHasMemberList() - Method in class org.dataone.service.types.v1.Group
Get the number of 'hasMember' element items.
sizeIsMemberOfList() - Method in class org.dataone.service.types.v1.Person
Get the number of 'isMemberOf' element items.
sizeLogEntryList() - Method in class org.dataone.service.types.v1.Log
Get the number of 'logEntry' element items.
sizeMonitorInfoList() - Method in class org.dataone.service.types.v1.MonitorList
Get the number of 'monitorInfo' element items.
sizeNodeList() - Method in class org.dataone.service.types.v1.NodeList
Get the number of 'node' element items.
sizeObjectFormatList() - Method in class org.dataone.service.types.v1.ObjectFormatList
Get the number of 'objectFormat' element items.
sizeObjectInfoList() - Method in class org.dataone.service.types.v1.ObjectList
Get the number of 'objectInfo' element items.
sizeObjectLocationList() - Method in class org.dataone.service.types.v1.ObjectLocationList
Get the number of 'objectLocation' element items.
sizePermissionList() - Method in class org.dataone.service.types.v1.AccessRule
Get the number of 'permission' element items.
sizePersonList() - Method in class org.dataone.service.types.v1.SubjectInfo
Get the number of 'person' element items.
sizePreferredMemberNodeList() - Method in class org.dataone.service.types.v1.ReplicationPolicy
Get the number of 'preferredMemberNode' element items.
sizeQueryEngineList() - Method in class org.dataone.service.types.v1_1.QueryEngineList
Get the number of 'queryEngine' element items.
sizeQueryFieldList() - Method in class org.dataone.service.types.v1_1.QueryEngineDescription
Get the number of 'queryField' element items.
sizeReplicaList() - Method in class org.dataone.service.types.v1.SystemMetadata
Get the number of 'replica' element items.
sizeRestrictionList() - Method in class org.dataone.service.types.v1.Service
Get the number of 'restriction' element items.
sizeRightsHolderList() - Method in class org.dataone.service.types.v1.Group
Get the number of 'rightsHolder' element items.
sizeServiceList() - Method in class org.dataone.service.types.v1.Services
Get the number of 'service' element items.
sizeSubjectList() - Method in class org.dataone.service.types.v1.AccessRule
Get the number of 'subject' element items.
sizeSubjectList() - Method in class org.dataone.service.types.v1.Node
Get the number of 'subject' element items.
sizeSubjectList() - Method in class org.dataone.service.types.v1.SubjectList
Get the number of 'subject' element items.
sizeVersionList() - Method in class org.dataone.service.types.v1.ObjectLocation
Get the number of 'version' element items.
Slice - Class in org.dataone.service.types.v1
An abstract type used as a common base for other types that need to include *count*, *start*, and *total* attributes to indicate which slice of a list is represented by a set of records.The first element in a list is always index 0, i.e.
Slice() - Constructor for class org.dataone.service.types.v1.Slice
 
standardizeDN(String) - Method in class org.dataone.client.auth.CertificateManager
Returns D1-wide consistent Subject DN string representations
STD_CONFIG_PATH - Static variable in class org.dataone.configuration.Settings
 
Subject - Class in org.dataone.service.types.v1
An identifier for a Person (user), Group, Organization, or System.The :term:`Subject` is a string that provides a formal name to identify a user or group in the DataONE Identity Management Service.
Subject() - Constructor for class org.dataone.service.types.v1.Subject
 
SUBJECT_AUTHENTICATED_USER - Static variable in class org.dataone.service.util.Constants
 
SUBJECT_PUBLIC - Static variable in class org.dataone.service.util.Constants
 
SUBJECT_VERIFIED_USER - Static variable in class org.dataone.service.util.Constants
 
SubjectInfo - Class in org.dataone.service.types.v1
A list of :term:`Subjects`, including both :class:`Types.Person` and :class:`Types.Group` entries returned from the :func:`CNIdentity.getSubjectInfo` service and :func:`CNIdentity.listSubjects` services.
SubjectInfo() - Constructor for class org.dataone.service.types.v1.SubjectInfo
 
SubjectList - Class in org.dataone.service.types.v1
A list of :term:`Subjects` used for identity/group management Schema fragment(s) for this class:
SubjectList() - Constructor for class org.dataone.service.types.v1.SubjectList
 
supportedFormatIdentifiers - Static variable in class org.dataone.eml.DataoneEMLParser
 
supportedNamespaceSummary - Static variable in class org.dataone.eml.DataoneEMLParser
 
Synchronization - Class in org.dataone.service.types.v1
Configuration information for the process by which metadata is harvested from Member Nodes to Coordinating Nodes, including the schedule on which harvesting should occur, and information about the last :term:`synchronization` attempts for the node.
Synchronization() - Constructor for class org.dataone.service.types.v1.Synchronization
 
synchronizationFailed(SynchronizationFailed) - Method in class org.dataone.client.MNode
synchronizationFailed(Session, SynchronizationFailed) - Method in class org.dataone.client.MNode
SynchronizationFailed - Exception in org.dataone.service.exceptions
The DataONE SynchronizationFailed exception, used as a callback message to a Member Node from a Coordinating Node when an attempt to synchronize some object fails.
SynchronizationFailed(String, String) - Constructor for exception org.dataone.service.exceptions.SynchronizationFailed
 
SynchronizationFailed(String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.SynchronizationFailed
 
SynchronizationFailed(String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.SynchronizationFailed
 
SynchronizationFailed(String, String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.SynchronizationFailed
 
synchronizationFailed(SynchronizationFailed) - Method in interface org.dataone.service.mn.tier1.v1.MNRead
 
synchronizationFailed(Session, SynchronizationFailed) - Method in interface org.dataone.service.mn.tier1.v1.MNRead
Deprecated.
SysMetaModificationDateComparator - Class in org.dataone.service.types.v1.comparators
A Comparator compares two SystemMetadata objects base on the date of the modification.
SysMetaModificationDateComparator() - Constructor for class org.dataone.service.types.v1.comparators.SysMetaModificationDateComparator
 
SysMetaUploadDateComparator - Class in org.dataone.service.types.v1.comparators
A Comparator compares two SystemMetadata objects base on the date of the upload.
SysMetaUploadDateComparator() - Constructor for class org.dataone.service.types.v1.comparators.SysMetaUploadDateComparator
 
SystemMetadata - Class in org.dataone.service.types.v1
System metadata (often referred to as :term:`sysmeta`) is the information used by DataONE to track and manage objects across the distributed Coordinating and Member Nodes of the network.
SystemMetadata() - Constructor for class org.dataone.service.types.v1.SystemMetadata
 
systemMetadataChanged(Identifier, long, Date) - Method in class org.dataone.client.MNode
systemMetadataChanged(Session, Identifier, long, Date) - Method in class org.dataone.client.MNode
systemMetadataChanged(Identifier, long, Date) - Method in interface org.dataone.service.mn.tier2.v1.MNAuthorization
 
systemMetadataChanged(Session, Identifier, long, Date) - Method in interface org.dataone.service.mn.tier2.v1.MNAuthorization
Deprecated.

T

TEMP_DIR - Static variable in class org.dataone.service.util.Constants
Deprecated.
this is OS-specific and should not be used
throttleIntervalSec - Static variable in class org.dataone.client.ObjectFormatCache
 
toString() - Method in class org.dataone.service.util.D1Url
 
trimAndValidateString(String) - Static method in class org.dataone.service.util.D1Url
 
TypeCompareUtil - Class in org.dataone.service.types
This utility class provides an efficient way to test bean-style data objects (of the same type) for differences in property values.
TypeCompareUtil() - Constructor for class org.dataone.service.types.TypeCompareUtil
 
TypeMarshaller - Class in org.dataone.service.util
The standard class used to marshal and unmarshal datatypes to and from input and output streams and file structures.
TypeMarshaller() - Constructor for class org.dataone.service.util.TypeMarshaller
 

U

unmarshalTypeFromFile(Class<T>, String) - Static method in class org.dataone.service.util.TypeMarshaller
Unmarshalls the contents of the filenamePath into the specified domainClass
unmarshalTypeFromFile(Class<T>, File) - Static method in class org.dataone.service.util.TypeMarshaller
Unmarshalls the contents of file parameter to the specified domainClass
unmarshalTypeFromStream(Class<T>, InputStream) - Static method in class org.dataone.service.util.TypeMarshaller
Unmarshalls the inputStream to the specified domainClass and unequivocally closes the passed in InputStream
UnsupportedMetadataType - Exception in org.dataone.service.exceptions
The DataONE UnsupportedMetadataType exception, raised when the science metadata document submitted is not of a type that is recognized by the DataONE system.
UnsupportedMetadataType(String, String) - Constructor for exception org.dataone.service.exceptions.UnsupportedMetadataType
 
UnsupportedMetadataType(String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.UnsupportedMetadataType
 
UnsupportedMetadataType(String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.UnsupportedMetadataType
 
UnsupportedMetadataType(String, String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.UnsupportedMetadataType
 
UnsupportedType - Exception in org.dataone.service.exceptions
The DataONE UnsupportedType exception, raised when the information presented appears to be unsupported.
UnsupportedType(String, String) - Constructor for exception org.dataone.service.exceptions.UnsupportedType
 
UnsupportedType(String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.UnsupportedType
 
UnsupportedType(String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.UnsupportedType
 
UnsupportedType(String, String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.UnsupportedType
 
update(Session, D1Object) - Static method in class org.dataone.client.D1Client
Perform an update an object in DataONE with the given D1Object on the originMemberNode contained in its systemMetadata.
update(Identifier, InputStream, Identifier, SystemMetadata) - Method in class org.dataone.client.MNode
update(Session, Identifier, InputStream, Identifier, SystemMetadata) - Method in class org.dataone.client.MNode
update(Identifier, InputStream, Identifier, SystemMetadata) - Method in interface org.dataone.service.mn.tier3.v1.MNStorage
 
update(Session, Identifier, InputStream, Identifier, SystemMetadata) - Method in interface org.dataone.service.mn.tier3.v1.MNStorage
Deprecated.
updateAccount(Person) - Method in class org.dataone.client.CNode
updateAccount(Session, Person) - Method in class org.dataone.client.CNode
updateAccount(Person) - Method in interface org.dataone.service.cn.v1.CNIdentity
 
updateAccount(Session, Person) - Method in interface org.dataone.service.cn.v1.CNIdentity
Deprecated.
updateGroup(Group) - Method in class org.dataone.client.CNode
updateGroup(Session, Group) - Method in class org.dataone.client.CNode
updateGroup(Group) - Method in interface org.dataone.service.cn.v1.CNIdentity
 
updateGroup(Session, Group) - Method in interface org.dataone.service.cn.v1.CNIdentity
Deprecated.
updateNodeCapabilities(NodeReference, Node) - Method in class org.dataone.client.CNode
updateNodeCapabilities(Session, NodeReference, Node) - Method in class org.dataone.client.CNode
updateNodeCapabilities(NodeReference, Node) - Method in interface org.dataone.service.cn.v1.CNRegister
 
updateNodeCapabilities(Session, NodeReference, Node) - Method in interface org.dataone.service.cn.v1.CNRegister
Deprecated.
updateReplicationMetadata(Identifier, Replica, long) - Method in class org.dataone.client.CNode
updateReplicationMetadata(Session, Identifier, Replica, long) - Method in class org.dataone.client.CNode
updateReplicationMetadata(Identifier, Replica, long) - Method in interface org.dataone.service.cn.v1.CNReplication
 
updateReplicationMetadata(Session, Identifier, Replica, long) - Method in interface org.dataone.service.cn.v1.CNReplication
Deprecated.
uploadDataPackages(MNode, File) - Method in class org.dataone.client.examples.ExampleDataPackageUpload
Uploads data packages in rootDir to targetMN.
uploadDataPackageWithRetry(MNode, File, int) - Method in class org.dataone.client.examples.ExampleDataPackageUpload
Uploads data package in tmpDir to targetMN.
url - Variable in class org.dataone.eml.EMLDocument.DistributionMetadata
 
usingFallbackFormatList - Static variable in class org.dataone.client.ObjectFormatCache
 

V

validateRequest(Identifier, byte[], ObjectFormatIdentifier, Subject, NodeReference) - Static method in class org.dataone.client.D1Object
Check the given set of input arguments that they are all valid and not null, and that string values are not null and of non-zero length.
validateResourceMap(ResourceMap) - Method in class org.dataone.ore.ResourceMapFactory
Validate the ResourceMap against DataONE constraints (use of CN_Read.resolve, identifier triple defined, identifier matching URI, aggregation resource using {resourceMapID}#aggregation)
valueOf(String) - Static method in enum org.dataone.service.types.v1.Event
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.dataone.service.types.v1.NodeState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.dataone.service.types.v1.NodeType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.dataone.service.types.v1.Permission
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.dataone.service.types.v1.ReplicationStatus
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.dataone.service.types.v1.Event
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.dataone.service.types.v1.NodeState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.dataone.service.types.v1.NodeType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.dataone.service.types.v1.Permission
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.dataone.service.types.v1.ReplicationStatus
Returns an array containing the constants of this enum type, in the order they are declared.
verify(X509Certificate, X509Certificate) - Static method in class org.dataone.client.auth.CertificateManager
 
verify(X509Certificate, X509Certificate, boolean) - Static method in class org.dataone.client.auth.CertificateManager
Check the validity of a certificate, and be sure that it is verifiable using the given CA certificate.
verifyAccount(Subject) - Method in class org.dataone.client.CNode
verifyAccount(Session, Subject) - Method in class org.dataone.client.CNode
verifyAccount(Subject) - Method in interface org.dataone.service.cn.v1.CNIdentity
 
verifyAccount(Session, Subject) - Method in interface org.dataone.service.cn.v1.CNIdentity
Deprecated.
VersionMismatch - Exception in org.dataone.service.exceptions
The DataONE VersionMismatch exception, raised when the serialVersion supplied with the request does not match the serialVersion of the target
VersionMismatch(String, String) - Constructor for exception org.dataone.service.exceptions.VersionMismatch
 
VersionMismatch(String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.VersionMismatch
 
VersionMismatch(String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.VersionMismatch
 
VersionMismatch(String, String, String, String, TreeMap<String, String>) - Constructor for exception org.dataone.service.exceptions.VersionMismatch
 

X

xmlValue() - Method in enum org.dataone.service.types.v1.Event
 
xmlValue() - Method in enum org.dataone.service.types.v1.NodeState
 
xmlValue() - Method in enum org.dataone.service.types.v1.NodeType
 
xmlValue() - Method in enum org.dataone.service.types.v1.Permission
 
xmlValue() - Method in enum org.dataone.service.types.v1.ReplicationStatus
 
A B C D E F G H I J L M N O P Q R S T U V X 

Copyright © 2014. All Rights Reserved.