org.opencastproject.security.api

Class JaxbOrganization

java.lang.Object

org.opencastproject.security.api.JaxbOrganization

All Implemented Interfaces:

Organization

Direct Known Subclasses:

DefaultOrganization

public class JaxbOrganization
extends Object
implements Organization

An organization that is hosted on this Opencast instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JaxbOrganization.OrgProperty An organization property.
static class	JaxbOrganization.OrgServer An organization property.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	adminRole The local admin role name
protected String	anonymousRole The local anonymous role name
protected String	id The organizational identifier
protected String	name The friendly name of the organization
protected List<JaxbOrganization.OrgProperty>	properties Arbitrary string properties associated with this organization
protected List<JaxbOrganization.OrgServer>	servers Server and port mapping

Constructor Summary

Constructors

Constructor and Description
JaxbOrganization() No-arg constructor needed by JAXB
JaxbOrganization(String orgId)
JaxbOrganization(String id, String name, Map<String,Integer> servers, String adminRole, String anonymousRole, Map<String,String> properties) Constructs an organization with its attributes.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static JaxbOrganization	fromOrganization(Organization org) Constructs an organization from an organization
String	getAdminRole() Returns the name for the local admin role.
String	getAnonymousRole() Returns the name for the local anonymous role.
String	getId()
String	getName()
Map<String,String>	getProperties() Returns the organizational properties
Map<String,Integer>	getServers() Returns the server names and the corresponding ports that have been registered with this organization.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

protected String id

The organizational identifier

name

protected String name

The friendly name of the organization

servers

protected List<JaxbOrganization.OrgServer> servers

Server and port mapping

adminRole

protected String adminRole

The local admin role name

anonymousRole

protected String anonymousRole

The local anonymous role name

properties

protected List<JaxbOrganization.OrgProperty> properties

Arbitrary string properties associated with this organization

Constructor Detail

JaxbOrganization

public JaxbOrganization()

No-arg constructor needed by JAXB

JaxbOrganization

public JaxbOrganization(String orgId)

JaxbOrganization

public JaxbOrganization(String id,
                        String name,
                        Map<String,Integer> servers,
                        String adminRole,
                        String anonymousRole,
                        Map<String,String> properties)

Constructs an organization with its attributes.

Parameters:

id - the unique identifier

name - the friendly name

servers - the hosts names and ports

adminRole - name of the local admin role

anonymousRole - name of the local anonymous role

properties - arbitrary properties defined for this organization, which might include branding, etc.

Method Detail

fromOrganization

public static JaxbOrganization fromOrganization(Organization org)

Constructs an organization from an organization

Parameters:

org - the organization

getId

public String getId()

Specified by:

getId in interface Organization

Returns:

the id

See Also:

Organization.getId()

getName

public String getName()

Specified by:

getName in interface Organization

Returns:

the name

See Also:

Organization.getName()

getServers

public Map<String,Integer> getServers()

Description copied from interface: Organization

Returns the server names and the corresponding ports that have been registered with this organization.

Specified by:

getServers in interface Organization

Returns:

the servers

See Also:

Organization.getServers()

getAdminRole

public String getAdminRole()

Description copied from interface: Organization

Returns the name for the local admin role.

Specified by:

getAdminRole in interface Organization

Returns:

the admin role name

See Also:

Organization.getId()

getAnonymousRole

public String getAnonymousRole()

Description copied from interface: Organization

Returns the name for the local anonymous role.

Specified by:

getAnonymousRole in interface Organization

Returns:

the anonymous role name

See Also:

Organization.getId()

getProperties

public Map<String,String> getProperties()

Description copied from interface: Organization

Returns the organizational properties

Specified by:

getProperties in interface Organization

Returns:

the properties

See Also:

Organization.getProperties()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()