Package org.opencastproject.kernel.security

Class OrganizationDirectoryServiceImpl

java.lang.Object

org.opencastproject.kernel.security.OrganizationDirectoryServiceImpl

All Implemented Interfaces:

OrganizationDirectoryService, org.osgi.service.cm.ManagedServiceFactory

public class OrganizationDirectoryServiceImpl
extends Object
implements OrganizationDirectoryService, org.osgi.service.cm.ManagedServiceFactory

Implements the organizational directory. As long as no organizations are published in the service registry, the directory will contain the default organization as the only instance.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.osgi.service.cm.ConfigurationAdmin	configAdmin	The configuration admin service
static final String	DEFAULT_SERVER_HOST	The default host in case no server is configured
static final int	DEFAULT_SERVER_PORT	The default port in case no server is configured
static final String	ORG_ADMIN_ROLE_KEY	The managed property that specifies the organization administrative role
static final String	ORG_ANONYMOUS_ROLE_KEY	The managed property that specifies the organization anonymous role
static final String	ORG_ID_KEY	The managed property that specifies the organization id
static final String	ORG_NAME_KEY	The managed property that specifies the organization name
static final String	ORG_PROPERTY_PREFIX	The prefix for configurations to use for arbitrary organization properties
static final String	ORG_SERVER_PREFIX	The managed property that specifies the organization server name
static final String	PID	The organization service PID

Constructor Summary

Constructors

Constructor	Description
OrganizationDirectoryServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	addOrganization(Organization organization)	Adds the organization to the list of organizations.
void	addOrganizationDirectoryListener(OrganizationDirectoryListener listener)	Adds listener to the list of organization listeners.
void	deleted(String pid)
String	getName()
Organization	getOrganization(String id)	Gets an organization by its identifier.
Organization	getOrganization(URL url)	Gets an organization by request URL.
List<Organization>	getOrganizations()	Gets all registered organizations.
void	removeOrganizationDirectoryListener(OrganizationDirectoryListener listener)	Removes listener from the list of organization listeners.
void	setConfigurationAdmin(org.osgi.service.cm.ConfigurationAdmin configAdmin)
void	setOrgPersistence(OrganizationDatabase setOrgPersistence)	OSGi DI
void	updated(String pid, Dictionary properties)

Methods inherited from class java.lang.Object

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

Field Details

PID

public static final String PID

The organization service PID

See Also:

• Constant Field Values

ORG_PROPERTY_PREFIX

public static final String ORG_PROPERTY_PREFIX

The prefix for configurations to use for arbitrary organization properties

See Also:

• Constant Field Values

ORG_ID_KEY

public static final String ORG_ID_KEY

The managed property that specifies the organization id

See Also:

• Constant Field Values

ORG_NAME_KEY

public static final String ORG_NAME_KEY

The managed property that specifies the organization name

See Also:

• Constant Field Values

ORG_SERVER_PREFIX

public static final String ORG_SERVER_PREFIX

The managed property that specifies the organization server name

See Also:

• Constant Field Values

DEFAULT_SERVER_HOST

public static final String DEFAULT_SERVER_HOST

The default host in case no server is configured

See Also:

• Constant Field Values

DEFAULT_SERVER_PORT

public static final int DEFAULT_SERVER_PORT

The default port in case no server is configured

See Also:

• Constant Field Values

ORG_ADMIN_ROLE_KEY

public static final String ORG_ADMIN_ROLE_KEY

The managed property that specifies the organization administrative role

See Also:

• Constant Field Values

ORG_ANONYMOUS_ROLE_KEY

public static final String ORG_ANONYMOUS_ROLE_KEY

The managed property that specifies the organization anonymous role

See Also:

• Constant Field Values

configAdmin

protected org.osgi.service.cm.ConfigurationAdmin configAdmin

The configuration admin service

Constructor Details

OrganizationDirectoryServiceImpl

public OrganizationDirectoryServiceImpl()

Method Details

setOrgPersistence

public void setOrgPersistence(OrganizationDatabase setOrgPersistence)

OSGi DI

setConfigurationAdmin

public void setConfigurationAdmin(org.osgi.service.cm.ConfigurationAdmin configAdmin)

Parameters:

configAdmin - the configAdmin to set

getOrganization

public Organization getOrganization(String id)
                             throws NotFoundException

Description copied from interface: OrganizationDirectoryService

Gets an organization by its identifier.

Specified by:

getOrganization in interface OrganizationDirectoryService

Parameters:

id - the identifier

Returns:

the organization with this identifier

Throws:

NotFoundException

getOrganization

public Organization getOrganization(URL url)
                             throws NotFoundException

Description copied from interface: OrganizationDirectoryService

Gets an organization by request URL.

Specified by:

getOrganization in interface OrganizationDirectoryService

Parameters:

url - a request URL

Returns:

the organization that is mapped to this URL

Throws:

NotFoundException

getOrganizations

public List<Organization> getOrganizations()

Description copied from interface: OrganizationDirectoryService

Gets all registered organizations.

Specified by:

getOrganizations in interface OrganizationDirectoryService

Returns:

the organizations

addOrganization

public void addOrganization(Organization organization)

Adds the organization to the list of organizations.

Parameters:

organization - the organization

getName

public String getName()

Specified by:

getName in interface org.osgi.service.cm.ManagedServiceFactory

updated

public void updated(String pid,
 Dictionary properties)
             throws org.osgi.service.cm.ConfigurationException

Specified by:

updated in interface org.osgi.service.cm.ManagedServiceFactory

Throws:

org.osgi.service.cm.ConfigurationException

deleted

public void deleted(String pid)

Specified by:

deleted in interface org.osgi.service.cm.ManagedServiceFactory

addOrganizationDirectoryListener

public void addOrganizationDirectoryListener(OrganizationDirectoryListener listener)

Description copied from interface: OrganizationDirectoryService

Adds listener to the list of organization listeners.

Specified by:

addOrganizationDirectoryListener in interface OrganizationDirectoryService

Parameters:

listener - the organization listener

removeOrganizationDirectoryListener

public void removeOrganizationDirectoryListener(OrganizationDirectoryListener listener)

Description copied from interface: OrganizationDirectoryService

Removes listener from the list of organization listeners.

Specified by:

removeOrganizationDirectoryListener in interface OrganizationDirectoryService

Parameters:

listener - the organization listener