org.dataone.service.cn.v1

Interface CNAuthorization

All Known Subinterfaces:

CNode

All Known Implementing Classes:

MultipartCNode

public interface CNAuthorization

The DataONE CoordinatingNode Tier2 Authorization 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	isAuthorized(Identifier pid, Permission permission)
boolean	isAuthorized(Session session, Identifier pid, Permission permission) Deprecated.
boolean	setAccessPolicy(Identifier pid, AccessPolicy policy, long serialVersion)
boolean	setAccessPolicy(Session session, Identifier pid, AccessPolicy policy, long serialVersion) Deprecated.
Identifier	setRightsHolder(Identifier pid, Subject userId, long serialVersion)
Identifier	setRightsHolder(Session session, Identifier pid, Subject userId, long serialVersion) Deprecated.

Method Detail

setRightsHolder

Identifier setRightsHolder(Identifier pid,
                           Subject userId,
                           long serialVersion)
                    throws InvalidToken,
                           ServiceFailure,
                           NotFound,
                           NotAuthorized,
                           NotImplemented,
                           InvalidRequest,
                           VersionMismatch

Throws:

InvalidToken

ServiceFailure

NotFound

NotAuthorized

NotImplemented

InvalidRequest

VersionMismatch

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNAuthorization.setRightsHolder

isAuthorized

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

Throws:

ServiceFailure

InvalidToken

NotFound

NotAuthorized

NotImplemented

InvalidRequest

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNAuthorization.isAuthorized

setAccessPolicy

boolean setAccessPolicy(Identifier pid,
                        AccessPolicy policy,
                        long serialVersion)
                 throws InvalidToken,
                        NotFound,
                        NotImplemented,
                        NotAuthorized,
                        ServiceFailure,
                        InvalidRequest,
                        VersionMismatch

Throws:

InvalidToken

NotFound

NotImplemented

NotAuthorized

ServiceFailure

InvalidRequest

VersionMismatch

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNAuthorization.setAccessPolicy

setRightsHolder

@Deprecated
Identifier setRightsHolder(Session session,
                                       Identifier pid,
                                       Subject userId,
                                       long serialVersion)
                                throws InvalidToken,
                                       ServiceFailure,
                                       NotFound,
                                       NotAuthorized,
                                       NotImplemented,
                                       InvalidRequest,
                                       VersionMismatch

Deprecated.

Throws:

InvalidToken

ServiceFailure

NotFound

NotAuthorized

NotImplemented

InvalidRequest

VersionMismatch

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNAuthorization.setRightsHolder

isAuthorized

@Deprecated
boolean isAuthorized(Session session,
                                 Identifier pid,
                                 Permission permission)
                          throws ServiceFailure,
                                 InvalidToken,
                                 NotFound,
                                 NotAuthorized,
                                 NotImplemented,
                                 InvalidRequest

Deprecated.

Throws:

ServiceFailure

InvalidToken

NotFound

NotAuthorized

NotImplemented

InvalidRequest

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNAuthorization.isAuthorized

setAccessPolicy

@Deprecated
boolean setAccessPolicy(Session session,
                                    Identifier pid,
                                    AccessPolicy policy,
                                    long serialVersion)
                             throws InvalidToken,
                                    NotFound,
                                    NotImplemented,
                                    NotAuthorized,
                                    ServiceFailure,
                                    InvalidRequest,
                                    VersionMismatch

Deprecated.

Throws:

InvalidToken

NotFound

NotImplemented

NotAuthorized

ServiceFailure

InvalidRequest

VersionMismatch

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNAuthorization.setAccessPolicy