com.wewebu.ow.server.app

Class OwMainRoleManagerContext

java.lang.Object

com.wewebu.ow.server.app.OwMainRoleManagerContext

All Implemented Interfaces:

OwAOContext, OwBaseInitializer, OwRoleManagerContext

public class OwMainRoleManagerContext
extends Object
implements OwRoleManagerContext, OwAOContext

Main Role Manager Context Class Implementation. Instance stays active during session.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com

Since:

4.2.0.0

Constructor Summary

Constructors

Constructor and Description
OwMainRoleManagerContext(OwMainAppContext mainContext)

Method Summary

Methods

Modifier and Type	Method and Description
String	createTempDir(String strPrefix_p) creates a unique temp directory
void	deleteTempDir(String strDir_p) deletes a temp dir and all files within it
Object	getApplicationAttribute(String key_p) get a attribute from the application scope
OwBaseConfiguration	getBaseConfiguration() get the configuration information
String	getBasePath() get the base path to the application
String	getClientID() get a ID / name for the calling client
OwConfiguration	getConfiguration()
String	getConfigurationName() get a name for the configuration to use can be used to distinguish different applications
URL	getConfigURL(String strName_p) get the URL to the configuration file
OwBaseUserInfo	getCurrentUser() get the current user
OwHistoryManager	getHistoryManager() get the history manager of the current logged in user
String	getInitParameter(String strParamName_p) get a parameter from the config file
org.springframework.jdbc.core.JdbcTemplate	getJDBCTemplate() get a spring JDBC template for the default data source
Locale	getLocale() get the current locale, which can be used as a prefix/postfix to distinguish localization resources
OwMandator	getMandator() get the mandator interface of the current logged in user
String	getMandatorID() get a ID / name for the calling mandator
OwMandatorManager	getMandatorManager() get the mandator manager of the current logged in user
OwNetwork	getNetwork() get the network interface of the current logged in user
OwAOProvider	getUnmanagedAOProvider()
InputStream	getXMLConfigDoc(String strName_p) loads a XML Document either from local file, external file or from a JNDI context
boolean	hasLabel(String strName_p) check if a display label is defined for the given symbol name
boolean	isRoleManaged()
String	localize(String strKey_p, String strText_p) localizes a string
String	localize1(String strKey_p, String strText_p, String strAttribute1_p) localizes a string with additional parameter that is replaced with %1
String	localize2(String strKey_p, String strText_p, String strAttribute1_p, String strAttribute2_p) localizes a string with additional parameter that is replaced with %1
String	localize3(String strKey_p, String strText_p, String strAttribute1_p, String strAttribute2_p, String strAttribute3_p) localizes a string with additional parameter that is replaced with %1
String	localizeLabel(String strName_p) optionally translate a name into a readable label, used for property class names in ECM adaptors which do not support separate displaynames
Object	setApplicationAttribute(String key_p, Object object_p) set a attribute from the application scope

Methods inherited from class java.lang.Object

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

Constructor Detail

OwMainRoleManagerContext

public OwMainRoleManagerContext(OwMainAppContext mainContext)

Method Detail

getConfigURL

public URL getConfigURL(String strName_p)
                 throws Exception

Description copied from interface: OwBaseInitializer

get the URL to the configuration file

Specified by:

getConfigURL in interface OwBaseInitializer

Parameters:

strName_p - Name of the resource to look for

Returns:

URL of the configuration file

Throws:

Exception

getApplicationAttribute

public Object getApplicationAttribute(String key_p)

Description copied from interface: OwBaseInitializer

get a attribute from the application scope

Specified by:

getApplicationAttribute in interface OwBaseInitializer

Returns:

an Object

setApplicationAttribute

public Object setApplicationAttribute(String key_p,
                             Object object_p)

Description copied from interface: OwBaseInitializer

set a attribute from the application scope

Specified by:

setApplicationAttribute in interface OwBaseInitializer

Returns:

the previous object

getBaseConfiguration

public OwBaseConfiguration getBaseConfiguration()

Description copied from interface: OwRoleManagerContext

get the configuration information

Specified by:

getBaseConfiguration in interface OwRoleManagerContext

getJDBCTemplate

public org.springframework.jdbc.core.JdbcTemplate getJDBCTemplate()

Description copied from interface: OwRoleManagerContext

get a spring JDBC template for the default data source

Specified by:

getJDBCTemplate in interface OwRoleManagerContext

Returns:

the Spring JdbcTemplate

getLocale

public Locale getLocale()

Description copied from interface: OwRoleManagerContext

get the current locale, which can be used as a prefix/postfix to distinguish localization resources

Specified by:

getLocale in interface OwRoleManagerContext

Returns:

Locale

localizeLabel

public String localizeLabel(String strName_p)

Description copied from interface: OwRoleManagerContext

optionally translate a name into a readable label, used for property class names in ECM adaptors which do not support separate displaynames

Specified by:

localizeLabel in interface OwRoleManagerContext

Parameters:

strName_p - name e.g. attribute name to look for

Returns:

translated Display name if found in label file or the given attribute name if nothing could be translated.

hasLabel

public boolean hasLabel(String strName_p)

Description copied from interface: OwRoleManagerContext

check if a display label is defined for the given symbol name

Specified by:

hasLabel in interface OwRoleManagerContext

Parameters:

strName_p - name e.g. attribute name to look for

Returns:

true = displayname is defined for symbol

localize

public String localize(String strKey_p,
              String strText_p)

Description copied from interface: OwRoleManagerContext

localizes a string

Specified by:

localize in interface OwRoleManagerContext

Parameters:

strKey_p - Key value used to retrieve localized string from resource

strText_p - current language Text

Returns:

String localized strText_p

localize1

public String localize1(String strKey_p,
               String strText_p,
               String strAttribute1_p)

Description copied from interface: OwRoleManagerContext

localizes a string with additional parameter that is replaced with %1

Specified by:

localize1 in interface OwRoleManagerContext

Parameters:

strKey_p - Key value used to retrieve localized string from resource

strText_p - current language Text

strAttribute1_p - String that replaces %1 tokens

Returns:

String localized strText_p

localize2

public String localize2(String strKey_p,
               String strText_p,
               String strAttribute1_p,
               String strAttribute2_p)

Description copied from interface: OwRoleManagerContext

localizes a string with additional parameter that is replaced with %1

Specified by:

localize2 in interface OwRoleManagerContext

Parameters:

strKey_p - Key value used to retrieve localized string from resource

strText_p - current language Text

strAttribute1_p - String that replaces %1 tokens

strAttribute2_p - String that replaces %2 tokens

Returns:

String localized strText_p

localize3

public String localize3(String strKey_p,
               String strText_p,
               String strAttribute1_p,
               String strAttribute2_p,
               String strAttribute3_p)

Description copied from interface: OwRoleManagerContext

localizes a string with additional parameter that is replaced with %1

Specified by:

localize3 in interface OwRoleManagerContext

Parameters:

strKey_p - Key value used to retrieve localized string from resource

strText_p - current language Text

strAttribute1_p - String that replaces %1 tokens

strAttribute2_p - String that replaces %2 tokens

strAttribute3_p - String that replaces %3 tokens

Returns:

String localized strText_p

getConfigurationName

public String getConfigurationName()

Description copied from interface: OwRoleManagerContext

get a name for the configuration to use can be used to distinguish different applications

Specified by:

getConfigurationName in interface OwRoleManagerContext

Returns:

String a name for the configuration, or "default" to use default

getXMLConfigDoc

public InputStream getXMLConfigDoc(String strName_p)
                            throws Exception

Description copied from interface: OwRoleManagerContext

loads a XML Document either from local file, external file or from a JNDI context

Specified by:

getXMLConfigDoc in interface OwBaseInitializer

Specified by:

getXMLConfigDoc in interface OwRoleManagerContext

Parameters:

strName_p - Name of the resource to look for

Returns:

OwXMLUtil wrapped DOM Node, or null if not found

Throws:

Exception

getBasePath

public String getBasePath()

Description copied from interface: OwRoleManagerContext

get the base path to the application

Specified by:

getBasePath in interface OwBaseInitializer

Specified by:

getBasePath in interface OwRoleManagerContext

Returns:

String

getInitParameter

public String getInitParameter(String strParamName_p)

Description copied from interface: OwRoleManagerContext

get a parameter from the config file

Specified by:

getInitParameter in interface OwBaseInitializer

Specified by:

getInitParameter in interface OwRoleManagerContext

Parameters:

strParamName_p - Name of the requested parameter

Returns:

parameter value, of null if not set.

getCurrentUser

public OwBaseUserInfo getCurrentUser()
                              throws Exception

Description copied from interface: OwRoleManagerContext

get the current user

Specified by:

getCurrentUser in interface OwRoleManagerContext

Returns:

OwUserInfo

Throws:

Exception

deleteTempDir

public void deleteTempDir(String strDir_p)

Description copied from interface: OwRoleManagerContext

deletes a temp dir and all files within it

Specified by:

deleteTempDir in interface OwRoleManagerContext

Parameters:

strDir_p - String directory

createTempDir

public String createTempDir(String strPrefix_p)
                     throws OwConfigurationException

Description copied from interface: OwRoleManagerContext

creates a unique temp directory

Specified by:

createTempDir in interface OwRoleManagerContext

Parameters:

strPrefix_p - String prefix to use for name

Returns:

Returns the created tempDir.

Throws:

OwConfigurationException

getClientID

public String getClientID()

Description copied from interface: OwRoleManagerContext

get a ID / name for the calling client

Specified by:

getClientID in interface OwRoleManagerContext

Returns:

String

getMandatorID

public String getMandatorID()

Description copied from interface: OwRoleManagerContext

get a ID / name for the calling mandator

Specified by:

getMandatorID in interface OwRoleManagerContext

Returns:

String mandator or null if no mandator is supported

getMandator

public OwMandator getMandator()

Description copied from interface: OwRoleManagerContext

get the mandator interface of the current logged in user

Specified by:

getMandator in interface OwRoleManagerContext

Returns:

OwMandator or null if not yet defined

getNetwork

public OwNetwork getNetwork()

Description copied from interface: OwRoleManagerContext

get the network interface of the current logged in user

Specified by:

getNetwork in interface OwAOContext

Specified by:

getNetwork in interface OwRoleManagerContext

Returns:

OwNetwork or null if not yet defined

getHistoryManager

public OwHistoryManager getHistoryManager()

Description copied from interface: OwRoleManagerContext

get the history manager of the current logged in user

Specified by:

getHistoryManager in interface OwRoleManagerContext

Returns:

OwHistoryManager or null if not yet defined

getMandatorManager

public OwMandatorManager getMandatorManager()

Description copied from interface: OwRoleManagerContext

get the mandator manager of the current logged in user

Specified by:

getMandatorManager in interface OwRoleManagerContext

Returns:

OwMandatorManager or null if not yet defined

getUnmanagedAOProvider

public OwAOProvider getUnmanagedAOProvider()
                                    throws OwConfigurationException

Specified by:

getUnmanagedAOProvider in interface OwRoleManagerContext

Returns:

an application objects provider that is not subjected to role management restrictions

Throws:

OwConfigurationException

getConfiguration

public OwConfiguration getConfiguration()

Specified by:

getConfiguration in interface OwAOContext

isRoleManaged

public boolean isRoleManaged()

Specified by:

isRoleManaged in interface OwAOContext