CNIdentity (DataONE_Common

```
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

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

Method Detail

registerAccount

Subject registerAccount(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(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(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(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(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(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(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(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(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(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(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(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(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

registerAccount

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

Deprecated.

Throws:: ServiceFailure; NotAuthorized; IdentifierNotUnique; InvalidCredentials; NotImplemented; InvalidRequest; InvalidToken
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.registerAccount

updateAccount

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

Deprecated.

Throws:: ServiceFailure; NotAuthorized; InvalidCredentials; NotImplemented; InvalidRequest; InvalidToken; NotFound
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.updateAccount

verifyAccount

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

Deprecated.

Throws:: ServiceFailure; NotAuthorized; NotImplemented; InvalidToken; InvalidRequest; NotFound
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.verifyAccount

getSubjectInfo

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

Deprecated.

Throws:: ServiceFailure; NotAuthorized; NotImplemented; NotFound; InvalidToken
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.getSubjectInfo

listSubjects

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

Deprecated.

Throws:: InvalidRequest; ServiceFailure; InvalidToken; NotAuthorized; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.listSubjects

mapIdentity

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

Deprecated.

Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented; InvalidRequest; IdentifierNotUnique
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.mapIdentity

requestMapIdentity

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

Deprecated.

Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented; InvalidRequest; IdentifierNotUnique
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.requestMapIdentity

confirmMapIdentity

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

Deprecated.

Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.confirmMapIdentity

getPendingMapIdentity

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

Deprecated.

Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.getPendingMapIdentity

denyMapIdentity

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

Deprecated.

Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.denyMapIdentity

removeMapIdentity

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

Deprecated.

Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.removeMapIdentity

createGroup

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

Deprecated.

Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotImplemented; IdentifierNotUnique; InvalidRequest
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.createGroup

updateGroup

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

Deprecated.

Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented; InvalidRequest
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.updateGroup

Interface CNIdentity

Method Summary

Method Detail

registerAccount

updateAccount

verifyAccount

getSubjectInfo

listSubjects

mapIdentity

requestMapIdentity

confirmMapIdentity

getPendingMapIdentity

denyMapIdentity

removeMapIdentity

createGroup

updateGroup

registerAccount

updateAccount

verifyAccount

getSubjectInfo

listSubjects

mapIdentity

requestMapIdentity

confirmMapIdentity

getPendingMapIdentity

denyMapIdentity

removeMapIdentity

createGroup

updateGroup