Package org.opencastproject.security.api

Class AccessControlParser

java.lang.Object

org.opencastproject.security.api.AccessControlParser

public final class AccessControlParser
extends Object

Marshals and unmarshals AccessControlLists to/from XML.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACE	ACE constant used in JSON formatted access control entries
static final String	ACL	ACL constant used in JSON formatted access control entries
static final String	ACTION	Action constant used in JSON formatted access control entries
static final String	ALLOW	Allow constant used in JSON formatted access control entries
static final String	ENCODING	Encoding expected from all inputs
static final String	ROLE	Role constant used in JSON formatted access control entries

Method Summary

Modifier and Type	Method	Description
static AccessControlList	parseAcl(InputStream in)	Unmarshals an ACL from an xml input stream.
static AccessControlList	parseAcl(String serializedForm)	Parses a string into an ACL.
static AccessControlList	parseAclSilent(String serializedForm)	Same like parseAcl(String) but throws runtime exceptions in case of an error.
static String	toJson(AccessControlList acl)
static String	toJsonSilent(AccessControlList acl)
static String	toXml(AccessControlList acl)	Serializes an AccessControlList to its XML form.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ROLE

public static final String ROLE

Role constant used in JSON formatted access control entries

See Also:

• Constant Field Values

ACTION

public static final String ACTION

Action constant used in JSON formatted access control entries

See Also:

• Constant Field Values

ALLOW

public static final String ALLOW

Allow constant used in JSON formatted access control entries

See Also:

• Constant Field Values

ACL

public static final String ACL

ACL constant used in JSON formatted access control entries

See Also:

• Constant Field Values

ACE

public static final String ACE

ACE constant used in JSON formatted access control entries

See Also:

• Constant Field Values

ENCODING

public static final String ENCODING

Encoding expected from all inputs

See Also:

• Constant Field Values

Method Details

parseAcl

public static AccessControlList parseAcl(String serializedForm)
                                  throws IOException,
AccessControlParsingException

Parses a string into an ACL.

Parameters:

serializedForm - the string containing the xml or json formatted access control list.

Returns:

the access control list

Throws:

IOException - if the encoding is invalid

AccessControlParsingException - if the format is invalid

parseAclSilent

public static AccessControlList parseAclSilent(String serializedForm)

Same like parseAcl(String) but throws runtime exceptions in case of an error.

parseAcl

public static AccessControlList parseAcl(InputStream in)
                                  throws IOException,
AccessControlParsingException

Unmarshals an ACL from an xml input stream.

Parameters:

in - the xml input stream

Returns:

the acl

Throws:

IOException - if there is a problem unmarshaling the stream

AccessControlParsingException - if the format is invalid

toXml

public static String toXml(AccessControlList acl)
                    throws IOException

Serializes an AccessControlList to its XML form.

Parameters:

acl - the access control list

Returns:

the xml as a string

Throws:

IOException - if there is a problem marshaling the xml

toJson

public static String toJson(AccessControlList acl)
                     throws IOException

Throws:

IOException

toJsonSilent

public static String toJsonSilent(AccessControlList acl)