org.dataone.service.cn.v2

Interface CNIdentity

public interface CNIdentity

The DataONE CoordinatingNode Tier2 Identity interface. This defines an implementation interface for Coordinating Nodes that wish to build an implementation that is compliant with the DataONE service definitions.

Author:

Matthew Jones

Method Summary

Modifier and Type	Method and Description
boolean	confirmMapIdentity(Session session, Subject subject)
Subject	createGroup(Session session, Group group)
boolean	denyMapIdentity(Session session, Subject subject)
SubjectInfo	getPendingMapIdentity(Session session, Subject subject)
SubjectInfo	getSubjectInfo(Session session, Subject subject)
SubjectInfo	listSubjects(Session session, String query, String status, Integer start, Integer count)
boolean	mapIdentity(Session session, Subject primarySubject, Subject secondarySubject)
Subject	registerAccount(Session session, Person person)
boolean	removeMapIdentity(Session session, Subject subject)
boolean	requestMapIdentity(Session session, Subject subject)
Subject	updateAccount(Session session, Person person)
boolean	updateGroup(Session session, Group group)
boolean	verifyAccount(Session session, Subject subject)

Method Detail

registerAccount

Subject registerAccount(Session session,
                        Person person)
                 throws ServiceFailure,
                        NotAuthorized,
                        IdentifierNotUnique,
                        InvalidCredentials,
                        NotImplemented,
                        InvalidRequest,
                        InvalidToken

Throws:

ServiceFailure

NotAuthorized

IdentifierNotUnique

InvalidCredentials

NotImplemented

InvalidRequest

InvalidToken

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.registerAccount

updateAccount

Subject updateAccount(Session session,
                      Person person)
               throws ServiceFailure,
                      NotAuthorized,
                      InvalidCredentials,
                      NotImplemented,
                      InvalidRequest,
                      InvalidToken,
                      NotFound

Throws:

ServiceFailure

NotAuthorized

InvalidCredentials

NotImplemented

InvalidRequest

InvalidToken

NotFound

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.updateAccount

verifyAccount

boolean verifyAccount(Session session,
                      Subject subject)
               throws ServiceFailure,
                      NotAuthorized,
                      NotImplemented,
                      InvalidToken,
                      InvalidRequest,
                      NotFound

Throws:

ServiceFailure

NotAuthorized

NotImplemented

InvalidToken

InvalidRequest

NotFound

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.verifyAccount

getSubjectInfo

SubjectInfo getSubjectInfo(Session session,
                           Subject subject)
                    throws ServiceFailure,
                           NotAuthorized,
                           NotImplemented,
                           NotFound,
                           InvalidToken

Throws:

ServiceFailure

NotAuthorized

NotImplemented

NotFound

InvalidToken

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.getSubjectInfo

listSubjects

SubjectInfo listSubjects(Session session,
                         String query,
                         String status,
                         Integer start,
                         Integer count)
                  throws InvalidRequest,
                         ServiceFailure,
                         InvalidToken,
                         NotAuthorized,
                         NotImplemented

Throws:

InvalidRequest

ServiceFailure

InvalidToken

NotAuthorized

NotImplemented

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.listSubjects

mapIdentity

boolean mapIdentity(Session session,
                    Subject primarySubject,
                    Subject secondarySubject)
             throws ServiceFailure,
                    InvalidToken,
                    NotAuthorized,
                    NotFound,
                    NotImplemented,
                    InvalidRequest,
                    IdentifierNotUnique

Throws:

ServiceFailure

InvalidToken

NotAuthorized

NotFound

NotImplemented

InvalidRequest

IdentifierNotUnique

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.mapIdentity

requestMapIdentity

boolean requestMapIdentity(Session session,
                           Subject subject)
                    throws ServiceFailure,
                           InvalidToken,
                           NotAuthorized,
                           NotFound,
                           NotImplemented,
                           InvalidRequest,
                           IdentifierNotUnique

Throws:

ServiceFailure

InvalidToken

NotAuthorized

NotFound

NotImplemented

InvalidRequest

IdentifierNotUnique

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.requestMapIdentity

confirmMapIdentity

boolean confirmMapIdentity(Session session,
                           Subject subject)
                    throws ServiceFailure,
                           InvalidToken,
                           NotAuthorized,
                           NotFound,
                           NotImplemented

Throws:

ServiceFailure

InvalidToken

NotAuthorized

NotFound

NotImplemented

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.confirmMapIdentity

getPendingMapIdentity

SubjectInfo getPendingMapIdentity(Session session,
                                  Subject subject)
                           throws ServiceFailure,
                                  InvalidToken,
                                  NotAuthorized,
                                  NotFound,
                                  NotImplemented

Throws:

ServiceFailure

InvalidToken

NotAuthorized

NotFound

NotImplemented

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.getPendingMapIdentity

denyMapIdentity

boolean denyMapIdentity(Session session,
                        Subject subject)
                 throws ServiceFailure,
                        InvalidToken,
                        NotAuthorized,
                        NotFound,
                        NotImplemented

Throws:

ServiceFailure

InvalidToken

NotAuthorized

NotFound

NotImplemented

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.denyMapIdentity

removeMapIdentity

boolean removeMapIdentity(Session session,
                          Subject subject)
                   throws ServiceFailure,
                          InvalidToken,
                          NotAuthorized,
                          NotFound,
                          NotImplemented

Throws:

ServiceFailure

InvalidToken

NotAuthorized

NotFound

NotImplemented

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.removeMapIdentity

createGroup

Subject createGroup(Session session,
                    Group group)
             throws ServiceFailure,
                    InvalidToken,
                    NotAuthorized,
                    NotImplemented,
                    IdentifierNotUnique,
                    InvalidRequest

Throws:

ServiceFailure

InvalidToken

NotAuthorized

NotImplemented

IdentifierNotUnique

InvalidRequest

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.createGroup

updateGroup

boolean updateGroup(Session session,
                    Group group)
             throws ServiceFailure,
                    InvalidToken,
                    NotAuthorized,
                    NotFound,
                    NotImplemented,
                    InvalidRequest

Throws:

ServiceFailure

InvalidToken

NotAuthorized

NotFound

NotImplemented

InvalidRequest

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.updateGroup