com.centrasite.control
Class Connector

java.lang.Object
  extended by com.centrasite.control.Connector
All Implemented Interfaces:
com.centrasite.jaxr.CentraSiteObjectCacheListener

public class Connector
extends java.lang.Object
implements com.centrasite.jaxr.CentraSiteObjectCacheListener


Field Summary
static java.lang.String FOLDER_ORG_CONFIG
           
static int LICENSE_COMMUNITY
           
static int LICENSE_ENTERPRISE
           
static int LICENSE_UNKNOWN
           
static java.lang.String PARAM_LANGUAGE
           
static java.lang.String PARAM_USER_LOCALE
           
 
Constructor Summary
Connector()
           
 
Method Summary
 void cacheCleared(com.centrasite.jaxr.CentraSiteObjectCache oc)
           
 boolean canGuestDownloadDocuments()
           
 void clearRegistryObjectCache()
           
 void connect(com.softwareag.cst.util.security.Credentials credentials, java.util.Locale locale, ActionContext context)
          Establish connection
 javax.xml.registry.Connection createConnection(com.softwareag.cst.util.security.Credentials credentials)
          Get a new JAXR connection - when used externally, the caller is responsible for closing the connection when no more used.
 void disconnect()
           
 AccessManager getAccessManager()
           
 com.softwareag.cis.plugin.util.ApplicationContext getApplicationContext()
           
 javax.xml.registry.BusinessLifeCycleManager getBusinessLifeCycleManager()
          Getter for m_blcm
 javax.xml.registry.BusinessQueryManager getBusinessQueryManager()
          Getter for m_bqm
 CapabilityManager getCapabilityManager()
           
 java.lang.String getConfiguredCrrUrl()
           
 javax.xml.registry.Connection getConnection()
          Get the underlying JAXR connection.
 ControlConfiguration getControlConfiguration()
          Get the control configuration.
 com.softwareag.cst.util.security.Credentials getCredentials()
          Get password.
 DateTimeTransformer getDateTimeTransformer()
           
 DisplayManager getDisplayManager()
           
 java.lang.String getEdition()
           
 ExtendedTypeInfoCache getExtendedTypeInfoCache()
          Obtain the ExtendedTypeInfoCache for this Connector
 AbstractExtensionCommand getExtensionCommand(java.lang.String extensionId)
          get the extension command for the given extension id
 java.util.Collection<java.lang.String> getFindqualifiers()
          Getter for m_findqualifiers
 GUIConfigurationExt getGUIConfiguration()
          Obtain the user's GUI configuration instance.
 com.centrasite.configuration.gui.GuiConfigurationInfo getGuiConfigurationInfo()
           
 ImageLoader getImageLoader()
           
 java.lang.String getInitParam(java.lang.String key)
           
 java.lang.String getINMConfigurationURL()
          Deprecated.  
 com.centrasite.jaxr.JAXRAccessor getJAXRAccessor()
           
 com.centrasite.lcmapi.LCMAdminManager getLCMAdminManager()
           
 com.centrasite.lcmapi.LCMRegistryService getLCMRegistryService()
           
 com.centrasite.lcmapi.LCMRuntimeManager getLCMRuntimeManager()
           
 java.util.Locale getLocale()
          Getter for m_language
 java.lang.String getNoChallengeUrl(java.lang.String externalUrl)
          Get repository access URL for access with implicit user
 com.centrasite.notification.NotificationManager getNotificationManager()
           
 com.centrasite.notification.NotificationManager getNotificationManager(java.lang.String conceptKey)
          Deprecated.  
 java.lang.String getParameter(java.lang.String name)
          Get value of parameter for Control plugin - configured in plugins/control.xml
 java.lang.String getPassword()
          Get password.
 java.util.Locale getPersitanceLocale()
          Getter for retrieving the locale that is used to persist new internationalized strings
 java.lang.String getProxyURL(java.lang.String relURL, boolean isHistoryFile)
           
 QueryManager getQueryManager()
           
 RegistryManager getRegistryManager()
           
 javax.xml.registry.RegistryService getRegistryService()
          Getter for m_registryService
 java.lang.String getRegistryUrl()
           
 javax.xml.registry.infomodel.User getRegistryUser()
          Get registry user
 com.centrasite.util.RepositoryConnector getRepositoryConnector()
           
 java.lang.String getRepositoryUrl()
           
 java.lang.String getRepositoryUrlInoDav()
          This method is intended for intzernal usage only.
 com.centrasite.resourceaccess.managers.ResourceAccessManager getResourceAccessManager()
          TRT2551 [Code refactoring in CentraSite]
 javax.servlet.ServletContext getServletContext()
          Get the servlet context.
 java.util.Properties getSSLProperties()
          Establish the SSL properties from the servlet's parameters
 java.lang.String getToken()
           
 int getTransactionNumber()
          In order to support modification an undo of arbitrary Items each Item may carry a transaction number inherited from the session context (i.e.
 com.centrasite.uddiv3.client.commons.api.RegistryService getUddiRegistryService()
           
 java.lang.String getUserName()
          Get name of current user
 void incrTransactionNumber()
          In order to support modification an undo of arbitrary Items each Item may carry a transaction number inherited from the session context (i.e.
 boolean isEnterpriseLicense()
           
 boolean isRTLMode()
          Determines if the current mode is RTL
 void lockItem(Item item, boolean lockWait)
           
 void removeFromRegistryObjectTypeCache(javax.xml.registry.infomodel.Concept concept)
          Remove CentraSiteTypeDescription for object type corresponding to given concept (from ObjectType classification scheme) from the registry's type cache
 void rollback()
           
 void setApplicationContext(com.softwareag.cis.plugin.util.ApplicationContext applCtx)
           
 void setBusinessLifeCycleManager(javax.xml.registry.BusinessLifeCycleManager blcm)
          Setter for m_blcm
 void setBusinessQueryManager(javax.xml.registry.BusinessQueryManager bqm)
          Setter for m_bqm
 void setControlConfiguration(ControlConfiguration controlConfig)
          Set the control configuration.
 void setLocale(java.util.Locale language)
          Setter for m_language
 void setPersitanceLocale(java.util.Locale value)
          Setter for retrieving the locale that is used to persist new internationalized strings
 void setRegistryService(javax.xml.registry.RegistryService registryService)
          Setter for m_registryService
 void setRegistryUrl(java.lang.String registryUrl)
           
 void setRTLMode(boolean isRTLMode)
          Set if the current mode is RTL.
 void setServletContext(javax.servlet.ServletContext servletContext)
          Set the servlet context.
 void setToken(java.lang.String token)
           
 boolean showColumnChooser()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LICENSE_UNKNOWN

public static final int LICENSE_UNKNOWN
See Also:
Constant Field Values

LICENSE_COMMUNITY

public static final int LICENSE_COMMUNITY
See Also:
Constant Field Values

LICENSE_ENTERPRISE

public static final int LICENSE_ENTERPRISE
See Also:
Constant Field Values

FOLDER_ORG_CONFIG

public static final java.lang.String FOLDER_ORG_CONFIG
See Also:
Constant Field Values

PARAM_LANGUAGE

public static final java.lang.String PARAM_LANGUAGE
See Also:
Constant Field Values

PARAM_USER_LOCALE

public static final java.lang.String PARAM_USER_LOCALE
See Also:
Constant Field Values
Constructor Detail

Connector

public Connector()
Method Detail

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)
Set the servlet context.

Parameters:
servletContext - servlet context

getServletContext

public javax.servlet.ServletContext getServletContext()
Get the servlet context.

Returns:
servlet context

setControlConfiguration

public void setControlConfiguration(ControlConfiguration controlConfig)
Set the control configuration.

Parameters:
controlConfig - configuration instance

getControlConfiguration

public ControlConfiguration getControlConfiguration()
Get the control configuration.

Returns:
configuration instance

getExtendedTypeInfoCache

public ExtendedTypeInfoCache getExtendedTypeInfoCache()
Obtain the ExtendedTypeInfoCache for this Connector

Returns:
the ExtendedTypeInfoCache

getGuiConfigurationInfo

public com.centrasite.configuration.gui.GuiConfigurationInfo getGuiConfigurationInfo()

connect

public void connect(com.softwareag.cst.util.security.Credentials credentials,
                    java.util.Locale locale,
                    ActionContext context)
             throws java.lang.Exception
Establish connection

Throws:
java.lang.Exception

getUddiRegistryService

public com.centrasite.uddiv3.client.commons.api.RegistryService getUddiRegistryService()

getDateTimeTransformer

public DateTimeTransformer getDateTimeTransformer()

getJAXRAccessor

public com.centrasite.jaxr.JAXRAccessor getJAXRAccessor()
                                                 throws javax.xml.registry.JAXRException
Throws:
javax.xml.registry.JAXRException

createConnection

public javax.xml.registry.Connection createConnection(com.softwareag.cst.util.security.Credentials credentials)
                                               throws javax.xml.registry.JAXRException
Get a new JAXR connection - when used externally, the caller is responsible for closing the connection when no more used.

Parameters:
securityContext -
Returns:
new JAXR connection
Throws:
javax.xml.registry.JAXRException

getConnection

public javax.xml.registry.Connection getConnection()
Get the underlying JAXR connection.

Returns:
JAXR connection

getQueryManager

public QueryManager getQueryManager()

getBusinessLifeCycleManager

public javax.xml.registry.BusinessLifeCycleManager getBusinessLifeCycleManager()
Getter for m_blcm

Returns:
Returns the blcm.

setBusinessLifeCycleManager

public void setBusinessLifeCycleManager(javax.xml.registry.BusinessLifeCycleManager blcm)
Setter for m_blcm

Parameters:
blcm - The blcm to set.

getBusinessQueryManager

public javax.xml.registry.BusinessQueryManager getBusinessQueryManager()
Getter for m_bqm

Returns:
Returns the bqm.

setBusinessQueryManager

public void setBusinessQueryManager(javax.xml.registry.BusinessQueryManager bqm)
Setter for m_bqm

Parameters:
bqm - The bqm to set.

getLocale

public java.util.Locale getLocale()
Getter for m_language

Returns:
Returns the language.

setLocale

public void setLocale(java.util.Locale language)
Setter for m_language

Parameters:
language - The language to set.

getPersitanceLocale

public java.util.Locale getPersitanceLocale()
Getter for retrieving the locale that is used to persist new internationalized strings

Returns:
Returns locale to be used to persist new internationalized strings

setPersitanceLocale

public void setPersitanceLocale(java.util.Locale value)
Setter for retrieving the locale that is used to persist new internationalized strings

Parameters:
value - locale

getRegistryService

public javax.xml.registry.RegistryService getRegistryService()
Getter for m_registryService

Returns:
Returns the registryService.

setRegistryService

public void setRegistryService(javax.xml.registry.RegistryService registryService)
Setter for m_registryService

Parameters:
registryService - The registryService to set.

getCredentials

public com.softwareag.cst.util.security.Credentials getCredentials()
Get password.

Returns:
The password.

getPassword

public java.lang.String getPassword()
Get password.

Returns:
The password.

getRegistryUser

public javax.xml.registry.infomodel.User getRegistryUser()
Get registry user

Returns:
The registry user.

getUserName

public java.lang.String getUserName()
Get name of current user

Returns:
Returns the current user's name.

getFindqualifiers

public java.util.Collection<java.lang.String> getFindqualifiers()
Getter for m_findqualifiers

Returns:
Returns the findqualifiers.

disconnect

public void disconnect()
                throws java.lang.Exception
Throws:
java.lang.Exception

canGuestDownloadDocuments

public boolean canGuestDownloadDocuments()

showColumnChooser

public boolean showColumnChooser()

getRegistryManager

public RegistryManager getRegistryManager()

getRegistryUrl

public java.lang.String getRegistryUrl()

setRegistryUrl

public void setRegistryUrl(java.lang.String registryUrl)

getRepositoryConnector

public com.centrasite.util.RepositoryConnector getRepositoryConnector()

getRepositoryUrl

public java.lang.String getRepositoryUrl()
Returns:
URL for access to CentraSite repository (no history files) - typically ending with "/ino:dav/ino:dav"

getRepositoryUrlInoDav

public java.lang.String getRepositoryUrlInoDav()
This method is intended for intzernal usage only.

Returns:
URL for access to CentraSite repository (including history files) - typically one trailing /ino:dav is stripped off, thus ending just with "/ino:dav"

getImageLoader

public ImageLoader getImageLoader()

getCapabilityManager

public CapabilityManager getCapabilityManager()

getAccessManager

public AccessManager getAccessManager()

getNotificationManager

public com.centrasite.notification.NotificationManager getNotificationManager()

getNotificationManager

public com.centrasite.notification.NotificationManager getNotificationManager(java.lang.String conceptKey)
                                                                       throws java.lang.Exception
Deprecated. 

Throws:
java.lang.Exception

getGUIConfiguration

public GUIConfigurationExt getGUIConfiguration()
Obtain the user's GUI configuration instance.

Returns:
user's gui configuration

setApplicationContext

public void setApplicationContext(com.softwareag.cis.plugin.util.ApplicationContext applCtx)

getApplicationContext

public com.softwareag.cis.plugin.util.ApplicationContext getApplicationContext()

getInitParam

public java.lang.String getInitParam(java.lang.String key)
Parameters:
key - name of query parameter
Returns:
the value of the query parameter passed at startup

getEdition

public java.lang.String getEdition()
Returns:
Returns Constants.EDITION_COMMUNITY, Constants.EDITION_ENTERPRISE, Constants.EDITION_ACTIVESOA

isEnterpriseLicense

public boolean isEnterpriseLicense()
Returns:
Returns true if Enterprise license

getTransactionNumber

public int getTransactionNumber()
In order to support modification an undo of arbitrary Items each Item may carry a transaction number inherited from the session context (i.e. Connector) when reading it from persistent storage.

Returns:
the transaction number (0 indicates: no transaction number)

incrTransactionNumber

public void incrTransactionNumber()
In order to support modification an undo of arbitrary Items each Item may carry a transaction number inherited from the session context (i.e. Connector) when reading it from persistent storage.


clearRegistryObjectCache

public void clearRegistryObjectCache()

removeFromRegistryObjectTypeCache

public void removeFromRegistryObjectTypeCache(javax.xml.registry.infomodel.Concept concept)
                                       throws javax.xml.registry.JAXRException
Remove CentraSiteTypeDescription for object type corresponding to given concept (from ObjectType classification scheme) from the registry's type cache

Parameters:
concept -
Throws:
javax.xml.registry.JAXRException

getConfiguredCrrUrl

public java.lang.String getConfiguredCrrUrl()
Returns:
configured CRR URL

getSSLProperties

public java.util.Properties getSSLProperties()
Establish the SSL properties from the servlet's parameters

Returns:
the SSL properties (null: nothing given)

getParameter

public java.lang.String getParameter(java.lang.String name)
Get value of parameter for Control plugin - configured in plugins/control.xml

Parameters:
name - the name of the parameter
Returns:
the parameter value or null, if parameter is not set

getNoChallengeUrl

public java.lang.String getNoChallengeUrl(java.lang.String externalUrl)
Get repository access URL for access with implicit user

Parameters:
externalUrl -
Returns:
the URL

cacheCleared

public void cacheCleared(com.centrasite.jaxr.CentraSiteObjectCache oc)
Specified by:
cacheCleared in interface com.centrasite.jaxr.CentraSiteObjectCacheListener

getProxyURL

public java.lang.String getProxyURL(java.lang.String relURL,
                                    boolean isHistoryFile)
Parameters:
relURL - a relative URL with the text behind ".../ino:dav/ino:dav" or ".../ino:dav/ino:davHistory"
isHistoryFile - if true, the URL for a history file is to be returned
Returns:
the URL for accessing the file via the proxy servlet

getToken

public java.lang.String getToken()

setToken

public void setToken(java.lang.String token)

lockItem

public void lockItem(Item item,
                     boolean lockWait)
              throws java.lang.Exception
Throws:
java.lang.Exception

rollback

public void rollback()

getDisplayManager

public DisplayManager getDisplayManager()

getLCMRegistryService

public com.centrasite.lcmapi.LCMRegistryService getLCMRegistryService()

getLCMAdminManager

public com.centrasite.lcmapi.LCMAdminManager getLCMAdminManager()
                                                         throws com.centrasite.lcmapi.LCMException
Throws:
com.centrasite.lcmapi.LCMException

getLCMRuntimeManager

public com.centrasite.lcmapi.LCMRuntimeManager getLCMRuntimeManager()
                                                             throws com.centrasite.lcmapi.LCMException
Throws:
com.centrasite.lcmapi.LCMException

getResourceAccessManager

public com.centrasite.resourceaccess.managers.ResourceAccessManager getResourceAccessManager()
TRT2551 [Code refactoring in CentraSite]

Returns:
ResourceAccessManager instance active throughout current Control session.

isRTLMode

public boolean isRTLMode()
Determines if the current mode is RTL

Returns:
the isRTLMode. Default(false)

setRTLMode

public void setRTLMode(boolean isRTLMode)
Set if the current mode is RTL.

Parameters:
isRTLMode - - the isRTLMode to set

getExtensionCommand

public AbstractExtensionCommand getExtensionCommand(java.lang.String extensionId)
get the extension command for the given extension id

Parameters:
extension - id
Returns:
the AbstractExtensionCommand

getINMConfigurationURL

public java.lang.String getINMConfigurationURL()
Deprecated. 

for backward compatibility