|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IProvider
Provides the abstract superclass for all collaboration service providers.
Method Summary | |
---|---|
void |
addClassMapping(Key key,
String sSource,
ItemClass target)
Programatically adds a class mapping to the default schema for the provider. |
String |
getBackendName(Locale locale)
Gets the name of the back-end data store or collaboration system. |
String |
getInternalName()
Gets an internal name for the provider (must be unique among all registered providers). |
String |
getLegalTrademarks(Locale locale)
Gets the legal information regarding the provider and its terms of legal use. |
List |
getLocales()
Gets the available locales for the provider. |
String |
getLoggerName()
Gets the name of the logger for the provider. |
String |
getName(Locale locale)
Gets a descriptive name for the provider. |
String |
getProviderProperty(String key)
Get a provider configuration property. |
List |
getRequiredSessionProperties(Map props)
Gets the required properties given that the specified properties have already been supplied. |
String |
getResourceBase()
Gets the base name of the resource bundle. |
List |
getSessionProperties(Map props)
Gets the required and optional session properties given that the specified properties have already been supplied. |
SessionProperty |
getSessionProperty(String sInternalName)
Gets a session property by its internal name. |
String |
getVendorName(Locale locale)
Gets the company that authored the provider. |
void |
setProviderProperty(String key,
String value)
Set a provider configuration property. |
boolean |
supportsCacheDependencies()
Determines if this provider supports cache dependency checking. |
boolean |
supportsSchema(String sSchema)
Determines if this provider supports a given schema. |
String |
toString()
Creates a string representation of the provider. |
void |
validateSessionProperties(com.compoze.collab.spi.Context ctx,
Map props)
Validates session properties for well-formedness and throws an exception if there is a problem. |
Method Detail |
---|
List getLocales()
List
of the available localesSessionProperty getSessionProperty(String sInternalName)
sInternalName
- the internal name
null
if no property
exists with this internal nameList getSessionProperties(Map props) throws CollaborationException
props
- the properties that have already been supplied,
or null
for no pre-supplied properties
List
of required and optional SessionProperty
objects, or null
if all properties have been supplied
CollaborationException
- if some of the supplied properties
were invalidList getRequiredSessionProperties(Map props) throws CollaborationException
props
- the properties that have already been supplied,
or null
for no pre-supplied properties
List
of required SessionProperty
objects in order to proceed, or null
if no
properties are required
CollaborationException
- if some of the supplied properties
were invalidvoid validateSessionProperties(com.compoze.collab.spi.Context ctx, Map props) throws CollaborationException
ctx
- the provider contextprops
- the properties to validate
CollaborationException
- if there is a problem with the
propertiesString getVendorName(Locale locale)
locale
- the locale
String getInternalName()
String getLegalTrademarks(Locale locale)
locale
- the localeString getName(Locale locale)
locale
- the locale
String getBackendName(Locale locale)
locale
- the locale
String getLoggerName()
String getResourceBase()
boolean supportsSchema(String sSchema)
sSchema
- the internal name of the schema (not null
)
true
if this provider supports the specified schemaboolean supportsCacheDependencies()
true
if the provider supports cache dependency
checkingString toString()
toString
in class Object
void setProviderProperty(String key, String value)
key
- property keyvalue
- property valueString getProviderProperty(String key)
key
- property key
null
if the property is not setvoid addClassMapping(Key key, 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)
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |