|
Compoze Software, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Provides the abstract superclass for all collaboration service providers.
Method Summary | |
void |
addClassMapping(Key key,
java.lang.String sSource,
ItemClass target)
Programatically adds a class mapping to the default schema for the provider. |
java.lang.String |
getBackendName(java.util.Locale locale)
Gets the name of the back-end data store or collaboration system. |
java.lang.String |
getInternalName()
Gets an internal name for the provider (must be unique among all registered providers). |
java.lang.String |
getLegalTrademarks(java.util.Locale locale)
Gets the legal information regarding the provider and its terms of legal use. |
java.util.List |
getLocales()
Gets the available locales for the provider. |
java.lang.String |
getLoggerName()
Gets the name of the logger for the provider. |
java.lang.String |
getName(java.util.Locale locale)
Gets a descriptive name for the provider. |
java.lang.String |
getProviderProperty(java.lang.String key)
Get a provider configuration property. |
java.util.List |
getRequiredSessionProperties(java.util.Map props)
Gets the required properties given that the specified properties have already been supplied. |
java.lang.String |
getResourceBase()
Gets the base name of the resource bundle. |
java.util.List |
getSessionProperties(java.util.Map props)
Gets the required and optional session properties given that the specified properties have already been supplied. |
SessionProperty |
getSessionProperty(java.lang.String sInternalName)
Gets a session property by its internal name. |
java.lang.String |
getVendorName(java.util.Locale locale)
Gets the company that authored the provider. |
void |
setProviderProperty(java.lang.String key,
java.lang.String value)
Set a provider configuration property. |
boolean |
supportsCacheDependencies()
Determines if this provider supports cache dependency checking. |
boolean |
supportsSchema(java.lang.String sSchema)
Determines if this provider supports a given schema. |
java.lang.String |
toString()
Creates a string representation of the provider. |
void |
validateSessionProperties(com.compoze.collab.spi.Context ctx,
java.util.Map props)
Validates session properties for well-formedness and throws an exception if there is a problem. |
Method Detail |
public java.util.List getLocales()
List
of the available localespublic SessionProperty getSessionProperty(java.lang.String sInternalName)
sInternalName
- the internal namenull
if no property
exists with this internal namepublic java.util.List getSessionProperties(java.util.Map props) throws CollaborationException
props
- the properties that have already been supplied,
or null
for no pre-supplied propertiesList
of required and optional SessionProperty
objects, or null
if all properties have been suppliedCollaborationException
- if some of the supplied properties
were invalidpublic java.util.List getRequiredSessionProperties(java.util.Map props) throws CollaborationException
props
- the properties that have already been supplied,
or null
for no pre-supplied propertiesList
of required SessionProperty
objects in order to proceed, or null
if no
properties are requiredCollaborationException
- if some of the supplied properties
were invalidpublic void validateSessionProperties(com.compoze.collab.spi.Context ctx, java.util.Map props) throws CollaborationException
ctx
- the provider contextprops
- the properties to validateCollaborationException
- if there is a problem with the
propertiespublic java.lang.String getVendorName(java.util.Locale locale)
locale
- the localepublic java.lang.String getInternalName()
public java.lang.String getLegalTrademarks(java.util.Locale locale)
locale
- the localepublic java.lang.String getName(java.util.Locale locale)
locale
- the localepublic java.lang.String getBackendName(java.util.Locale locale)
locale
- the localepublic java.lang.String getLoggerName()
public java.lang.String getResourceBase()
public boolean supportsSchema(java.lang.String sSchema)
sSchema
- the internal name of the schema (not null
)true
if this provider supports the specified schemapublic boolean supportsCacheDependencies()
true
if the provider supports cache dependency
checkingpublic java.lang.String toString()
toString
in class java.lang.Object
public void setProviderProperty(java.lang.String key, java.lang.String value)
key
- property keyvalue
- property valuepublic java.lang.String getProviderProperty(java.lang.String key)
key
- property keynull
if the property is not setpublic void addClassMapping(Key key, java.lang.String sSource, ItemClass target)
key
- the provider key to perform the mappingsSource
- the provider specific value to maptarget
- the target item class (MUST have an internal name)
|
Compoze Software, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |