com.centrasite.jaxr
Interface CentraSiteRegistryService

All Superinterfaces:
javax.xml.registry.RegistryService

public interface CentraSiteRegistryService
extends javax.xml.registry.RegistryService

Defines CentraSite extensions of the JAXR RegistryService interface.


Method Summary
 void clearTypeCache(java.lang.String typeName)
          Clear doctype cache for a specific type.
 javax.xml.registry.infomodel.User getCaller()
          Get the JAXR User object which represents the client that created the current JAXR Connection.
 CentraSiteConnection getConnection()
          Return the connection that created this registry service.
 java.lang.Object getContextVariable(java.lang.Object key)
          Retrieve a user-defined value for a given key, where the key/value pair was previously stored by calling setContextVariable.
 java.util.Locale getErrorMessageLocale()
          Return the error message locale.
 com.centrasite.jaxr.util.GuiConfigurationUtil getGUIConfigurationUtil()
          Get instance of GUIConfigurationUtil
 ImportArchiveAccessor getImportArchiveAccessor()
          Get the ImportArchiveAccessor
 CentraSiteObjectCache getObjectCache()
          Get object cache
 CentraSiteResourceAccessManager getResourceAccessManager()
          Get the ResourceAccessManager.
 java.util.Collection<CentraSiteLocale> getRestrictedLocales()
          Get the set of restricted locales.
 CentraSiteRevisionManager getRevisionManager()
          Get the RevisionManager.
 java.lang.String getServerVersion()
          Get the version of the CentraSite server.
 CentraSiteTextValidator getTextValidator()
          Get the TextValidator
 java.util.Locale getUserAccountLocale()
          For the currently logged in user return the locale that is defined in the user's GUI configuration.
 boolean isValidRestrictedLocale(CentraSiteLocale locale)
          Return whether the given CentraSite locale is in the set of restricted locales.
 boolean isValidRestrictedLocale(java.util.Locale locale)
          Return whether the given locale is in the set of restricted locales.
 void setContextVariable(java.lang.Object key, java.lang.Object value)
          Pass a user-defined key/value pair for being stored with this CentraSiteRegistryService instance.
 void setErrorMessageLocale(java.util.Locale locale)
          Set the error message locale.
 void setImportArchiveAccessor(ImportArchiveAccessor importArchiveAccessor)
          Set the ImportArchiveAccessor
 void setResourceAccessManager(CentraSiteResourceAccessManager ram)
          Set the ResourceAccessManager.
 void setRestrictedLocales(java.util.Collection<CentraSiteLocale> restrictedLocales)
          Define the set of restricted locales.
 
Methods inherited from interface javax.xml.registry.RegistryService
getBulkResponse, getBusinessLifeCycleManager, getBusinessQueryManager, getCapabilityProfile, getDeclarativeQueryManager, getDefaultPostalScheme, makeRegistrySpecificRequest
 

Method Detail

getCaller

javax.xml.registry.infomodel.User getCaller()
                                            throws javax.xml.registry.JAXRException
Get the JAXR User object which represents the client that created the current JAXR Connection. This user identified himself by calling Connection.setCredentials().

Returns:
the current user
Throws:
javax.xml.registry.JAXRException

clearTypeCache

void clearTypeCache(java.lang.String typeName)
Clear doctype cache for a specific type.

Parameters:
typeName - the type to be removed from the cache

getConnection

CentraSiteConnection getConnection()
Return the connection that created this registry service.

Returns:
the connection that created this registry service

getObjectCache

CentraSiteObjectCache getObjectCache()
Get object cache

Returns:
the object cache

getGUIConfigurationUtil

com.centrasite.jaxr.util.GuiConfigurationUtil getGUIConfigurationUtil()
Get instance of GUIConfigurationUtil

Returns:
instance of GUIConfigurationUtil

setResourceAccessManager

void setResourceAccessManager(CentraSiteResourceAccessManager ram)
                              throws javax.xml.registry.JAXRException
Set the ResourceAccessManager.

Parameters:
ram - the ResourceAccessManager
Throws:
javax.xml.registry.JAXRException

getResourceAccessManager

CentraSiteResourceAccessManager getResourceAccessManager()
                                                         throws javax.xml.registry.JAXRException
Get the ResourceAccessManager.

Returns:
the ResourceAccessManager. Maybe null.
Throws:
javax.xml.registry.JAXRException

getRevisionManager

CentraSiteRevisionManager getRevisionManager()
                                             throws javax.xml.registry.JAXRException
Get the RevisionManager.

Returns:
the RevisionManager.
Throws:
javax.xml.registry.JAXRException

setImportArchiveAccessor

void setImportArchiveAccessor(ImportArchiveAccessor importArchiveAccessor)
Set the ImportArchiveAccessor

Parameters:
importArchiveAccessor -

getImportArchiveAccessor

ImportArchiveAccessor getImportArchiveAccessor()
Get the ImportArchiveAccessor

Returns:
the import archive accessor (null: not specified)

getErrorMessageLocale

java.util.Locale getErrorMessageLocale()
                                       throws javax.xml.registry.JAXRException
Return the error message locale.

Returns:
the error message locale - if none was specified this is the current default locale.
Throws:
javax.xml.registry.JAXRException

setErrorMessageLocale

void setErrorMessageLocale(java.util.Locale locale)
                           throws javax.xml.registry.JAXRException
Set the error message locale.

Parameters:
locale - the error message locale
Throws:
javax.xml.registry.JAXRException

getTextValidator

CentraSiteTextValidator getTextValidator()
                                         throws javax.xml.registry.JAXRException
Get the TextValidator

Returns:
the TextValidator
Throws:
javax.xml.registry.JAXRException

setRestrictedLocales

void setRestrictedLocales(java.util.Collection<CentraSiteLocale> restrictedLocales)
                          throws javax.xml.registry.JAXRException
Define the set of restricted locales. If the specified collection is null or empty, then there will be no locale restriction.

Parameters:
restrictedLocales - the collection of restricted locales
Throws:
javax.xml.registry.JAXRException

getRestrictedLocales

java.util.Collection<CentraSiteLocale> getRestrictedLocales()
                                                            throws javax.xml.registry.JAXRException
Get the set of restricted locales. If the returned collection is empty this means that there is no locale restriction.

Returns:
the collection of restricted locales. May be empty but not null
Throws:
javax.xml.registry.JAXRException

isValidRestrictedLocale

boolean isValidRestrictedLocale(CentraSiteLocale locale)
                                throws javax.xml.registry.JAXRException
Return whether the given CentraSite locale is in the set of restricted locales. If the set of restricted locales is empty the method will return true.

Parameters:
locale - the locale to be checked
Returns:
true if the given CentraSite locale is in the set of restricted locales.
Throws:
javax.xml.registry.JAXRException

isValidRestrictedLocale

boolean isValidRestrictedLocale(java.util.Locale locale)
                                throws javax.xml.registry.JAXRException
Return whether the given locale is in the set of restricted locales. If the set of restricted locales is empty the method will return true.

Parameters:
locale - the locale to be checked
Returns:
true if the given locale is in the set of restricted locales.
Throws:
javax.xml.registry.JAXRException

getServerVersion

java.lang.String getServerVersion()
                                  throws javax.xml.registry.JAXRException
Get the version of the CentraSite server.

Returns:
the version of the CentraSite server
Throws:
javax.xml.registry.JAXRException

getUserAccountLocale

java.util.Locale getUserAccountLocale()
                                      throws javax.xml.registry.JAXRException
For the currently logged in user return the locale that is defined in the user's GUI configuration. If there is no GUI configuration return the default locale defined in the restricted locale set.

Returns:
the current user's locale
Throws:
javax.xml.registry.JAXRException

setContextVariable

void setContextVariable(java.lang.Object key,
                        java.lang.Object value)
Pass a user-defined key/value pair for being stored with this CentraSiteRegistryService instance. This can be used for attaching any kind of object to the registry service. The stored value can be retrieved by calling getContextVariable, or removed by passing a null value to setContextVariable.

Parameters:
key - the key.
vaue - the value.

getContextVariable

java.lang.Object getContextVariable(java.lang.Object key)
Retrieve a user-defined value for a given key, where the key/value pair was previously stored by calling setContextVariable.

Parameters:
key - the key.
Returns:
the value, or null in case nothing is currently stored for the given key.