AccessUtil (DataONE Java Client Library 1.3.0-SNAPSHOT API)

java.lang.Object
- org.dataone.service.types.v1.util.AccessUtil

```
public class AccessUtil
extends Object
```
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)
Developer Notes: Currently does not work with other authentication objects (Session, Person, Group, SubjectList), but nothing precludes this. You'll just want to be careful not to duplicate functionality in d1_libclient_java's org.dataone.client.auth.CertificateManager.

Author:

rnahf

Constructor Summary

Constructors
Constructor and Description

AccessUtil()

Constructors
Constructor and Description
`AccessUtil()`

Method Summary

Methods
Modifier and Type	Method and Description
`static AccessPolicy`	`addPublicAccess(AccessPolicy origPolicy)` 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).
`static AccessPolicy`	`buildAccessPolicy(HashMap<Subject,Set<Permission>> pmap)` creates an AccessPolicy instance where each contained AccessRule consists of one subject and that subject's permissions.
`static AccessPolicy`	`cloneAccessPolicy(AccessPolicy orig)`
`static AccessRule`	`cloneAccessRule(AccessRule orig)`
`static AccessRule`	`createAccessRule(String[] subjectStrings, Permission[] permissions)` creates an AccessRule containing the items specified in the parameters.
`static AccessRule`	`createAccessRule(Subject[] subjects, Permission[] permissions)` creates an AccessRule containing the items specified in the parameters.
`static List<Permission>`	`createReadWriteChangePermissionList()` Dead-simple convenience method for creating a standard permission set of Read and Write and ChangePermission
`static Permission[]`	`createReadWriteChangePermissions()` Dead-simple convenience method for creating a standard permission set of Read and Write and ChangePermission
`static List<Permission>`	`createReadWritePermissionList()` Dead-simple convenience method for creating a standard permission set of Read and Write.
`static Permission[]`	`createReadWritePermissions()` Dead-simple convenience method for creating a standard permission set of Read and Write.
`static AccessPolicy`	`createSingleRuleAccessPolicy(String[] subjectStrings, Permission[] permissions)` creates an AccessPolicy with a single AccessRule, and the AccessRule composed of Subjects and Permissions specified in the parameters.
`static List<Subject>`	`createSubjectList(String[] subjectStrings)` creates a java-List of Subject objects from the given String array.
`static HashMap<Subject,Set<Permission>>`	`getPermissionMap(AccessPolicy policy)`

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

- Constructor Detail
  - AccessUtil
```
public AccessUtil()
```
- Method Detail
  - createAccessRule
```
public static AccessRule createAccessRule(Subject[] subjects,
                          Permission[] permissions)
```
    creates an AccessRule containing the items specified in the parameters. If you have Lists of these things already, consider creating directly and using ar.setPermissions(List\ permissions), for example.
    
    Parameters:
    subjects - - an array of Subject objects
    permissions - - an array of Permission objects (enumeration elements)
    
    Returns:
    an AccessRule
  - createAccessRule
```
public static AccessRule createAccessRule(String[] subjectStrings,
                          Permission[] permissions)
```
    creates an AccessRule containing the items specified in the parameters. If you have Lists of these things already, consider creating directly and using ar.setPermissions(List\ permissions), for example.
    
    Parameters:
    subjects - - an array of Strings where each string becomes the value of a new Subject
    permissions - - an array of Permission objects (enumeration elements)
    
    Returns:
    an AccessRule instance
  - createSingleRuleAccessPolicy
```
public static AccessPolicy createSingleRuleAccessPolicy(String[] subjectStrings,
                                        Permission[] permissions)
```
    creates an AccessPolicy with a single AccessRule, and the AccessRule composed of Subjects and Permissions specified in the parameters.
    
    Parameters:
    subjectStrings - - an array of Strings where each string becomes the value of a new Subject
    permissions - - an array of Permission objects (enumeration elements)
    
    Returns:
    an AccessPolicy instance
  - createSubjectList
```
public static List<Subject> createSubjectList(String[] subjectStrings)
```
    creates a java-List of Subject objects from the given String array. The utility of this method is for manually created AccessRules and other dataONE objects that take a List of Subjects.
    
    Parameters:
    subjectStrings - - an array of Strings where each string becomes the value of a new Subject
    
    Returns:
    a List\ object
  - createReadWritePermissions
```
public static Permission[] createReadWritePermissions()
```
    Dead-simple convenience method for creating a standard permission set of Read and Write.
    
    Returns:
    a Permission array
  - createReadWriteChangePermissions
```
public static Permission[] createReadWriteChangePermissions()
```
    Dead-simple convenience method for creating a standard permission set of Read and Write and ChangePermission
    
    Returns:
    a Permission array
  - createReadWritePermissionList
```
public static List<Permission> createReadWritePermissionList()
```
    Dead-simple convenience method for creating a standard permission set of Read and Write.
    
    Returns:
    a List of Permission objects
  - createReadWriteChangePermissionList
```
public static List<Permission> createReadWriteChangePermissionList()
```
    Dead-simple convenience method for creating a standard permission set of Read and Write and ChangePermission
    
    Returns:
    a List of Permission objects
  - getPermissionMap
```
public static HashMap<Subject,Set<Permission>> getPermissionMap(AccessPolicy policy)
```
  - buildAccessPolicy
```
public static AccessPolicy buildAccessPolicy(HashMap<Subject,Set<Permission>> pmap)
```
    creates an AccessPolicy instance where each contained AccessRule consists of one subject and that subject's permissions.
    
    Parameters:
    pmap - - a permissionMap as generated by AccessUtil.getPermissionMap(accessPolicy)
    
    Returns:
    an AccessPolicy instance.
  - cloneAccessPolicy
```
public static AccessPolicy cloneAccessPolicy(AccessPolicy orig)
```
  - cloneAccessRule
```
public static AccessRule cloneAccessRule(AccessRule orig)
```
  - addPublicAccess
```
public static AccessPolicy addPublicAccess(AccessPolicy origPolicy)
```
    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). If null is passed in, returns an accessPolicy with the sole 'public read' AccessRule.
    
    Parameters:
    origPolicy -
    
    Returns:

Class AccessUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AccessUtil

Method Detail

createAccessRule

createAccessRule

createSingleRuleAccessPolicy

createSubjectList

createReadWritePermissions

createReadWriteChangePermissions

createReadWritePermissionList

createReadWriteChangePermissionList

getPermissionMap

buildAccessPolicy

cloneAccessPolicy

cloneAccessRule

addPublicAccess