|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRepositoryConfig
Represents the configuration of a content repository. Each Repository may have specific properties that are necessary in order to be properly configured. Please see the specific repositories documentation for configuration information.
****************WARNING****************
When getting binaries from the WLP Repository (including both a binary Node Property and also a binary PropertyChoice) the default is to return the InputStream as a ByteArrayInputStream, thus consuming server memory until the bytes are released. If your application will be reading in very large files, you may switch to streaming mode. This means that the InputStream returned may read directly from a database resource, depending on the database or driver. This is accomplished by creating a property on the RepositoryConfig called "STREAMING_ENABLED" with the value set to "true". To disable streaming you must remove the "STREAMING_ENABLED" property entirely. Switching to streaming mode must be done with caution as it places additional requirements on developers using the api. The issue is that the InputStream through a BLOB, may be attached to a database connection (or other transactional resource). The use of this stream must therefore be within the context of a transaction to ensure that it is isolated from uses by other threads, etc. If you don't begin a UserTransaction before calling this method and then either commit or rollback the tx after you close the InputStream, the connection may go back to the WLS connection Pool and will be reused by another thread. This will lead to deadlocking the server. All of the WLP code that uses the api (tags, servlets, portlets and admin tools) are all protected through the use of a transaction. For those that are calling the API directly, here is an example of wrapping the call in a tx with exception handling left out <p/>
try { Context initCtx = new InitialContext(); tx = (UserTransaction)initCtx.lookup( "java:comp/UserTransaction" ); tx.setTransactionTimeout( transactionTimeout ); tx.begin(); // This is deprecated now. // bytes = nodeOps.getPropertyBytes(nodeId, propertyId); bytes = INodeManager.getStream(context, nodeId, propertyId); // empty the bytes } finally { // make sure to close InputStream if ( bytes != null ) { bytes.close(); } if ( tx != null ) { switch ( tx.getStatus() ) { case Status.STATUS_ACTIVE: tx.commit(); break; case Status.STATUS_MARKED_ROLLBACK: tx.rollback(); break; default: // this is bad - an unexpected status // throw exception break; } } }
<p/>
An example of creating a default RepositoryConfig (which can also be done via new RepositoryConfig("repoName")) is:
RepositoryConfig repoConfig = new RepositoryConfig("repoName", DEFAULT_CLASS_NAME, new Properties());
Repository properties may be set when constructing the configuration. Property names and values are unique to the repository being configured. Well-known repository properties are represented by constants in this class with the naming convention *_KEY
. Set the property on the properties object used by the RepositoryConfig such as:
Properties props = new Properties(); props.setProperty(FILESYSTEM_DIRECTORY_KEY, "/path/to/files");
The configuration may be persisted using the IVirtualRepositoryManager.createRepositoryConfig(com.bea.content.ContentContext, IRepositoryConfig)
and IVirtualRepositoryManager.updateRepositoryConfig(com.bea.content.ContentContext, IRepositoryConfig)
methods. Such as:
IVirtualRepositoryManager repoManager = COntentManagerFactory.getVirtualRepositoryManager(); repoManager.createRepositoryConfig(context, repoConfig);
There is one other way to specify repository configuration details. This is accomplished using the content-config.xml descriptor and is documented with the WLP documentation on edocs. This is done for a repository configuration specific to an application and that configuration is deployed with the application. The API to create a configuration is provided when dynamic creation is appropriate for the application. The API to update a configuration will work against both configurations created by the API and present in the content-config.xml deployment descriptor. Changes made to a configuration present in the descriptor will be altered using a deployment plan (see the WLS documentation for details on this process) and will not be directly reflected in the content-config.xml deployment descriptor file in your application.
Field Summary | |
---|---|
static boolean |
DEFAULT_BINARY_CACHE_IS_ENABLED Default value to enable the binary cache. |
static int |
DEFAULT_BINARY_CACHE_MAX_ENTRIES Default value for the binary cache max-entries. |
static long |
DEFAULT_BINARY_CACHE_MAX_ENTRY_SIZE Default value in bytes for the binary cache max value size. |
static long |
DEFAULT_BINARY_CACHE_TTL Default value for the binary cache time-to-live. |
static String |
DEFAULT_CLASS_NAME The repository connection class for the WLP Repository. |
static String |
DEFAULT_EXPLICIT_CACHE_IS_ENABLED |
static String |
DEFAULT_EXPLICIT_CACHE_MAX_ENTRIES Default values for the explicit properties cache |
static String |
DEFAULT_EXPLICIT_CACHE_TTL |
static boolean |
DEFAULT_FULLTEXT_SEARCH_IS_ENABLED Default value to enable full-text search query support. |
static boolean |
DEFAULT_NODE_CACHE_IS_ENABLED Default value to enable the node cache. |
static int |
DEFAULT_NODE_CACHE_MAX_ENTRIES Default value for the node cache max-entries. |
static long |
DEFAULT_NODE_CACHE_TTL Default value for the node cache time-to-live. |
static String |
DEFAULT_NODE_OPS_HOME Deprecated No longer used. |
static String |
DEFAULT_OBJECT_CLASS_OPS_HOME Deprecated No longer used. |
static boolean |
DEFAULT_READ_ONLY Default value for the read-only flag on the repository configuration. |
static String |
DEFAULT_REPO_BINARY_CACHE_IS_ENABLED The default value used to determine if the WLP Repository binary cache is enabled. |
static String |
DEFAULT_REPO_BINARY_CACHE_MAX_ENTRIES The default number of entries in the WLP Repository binary cache. |
static String |
DEFAULT_REPO_BINARY_CACHE_MAX_ENTRY_SIZE The default maximum size of entries in the WLP Repository binary cache. |
static String |
DEFAULT_REPO_BINARY_CACHE_TTL The default Time to live for entries in the WLP Repository binary cache. |
static String |
DEFAULT_REPO_NODE_CACHE_IS_ENABLED The default value used to determine if the WLP Repository Node Cache is enabled. |
static String |
DEFAULT_REPO_NODE_CACHE_MAX_ENTRIES The default number of nodes to cache in the WLP Repository Node Cache. |
static String |
DEFAULT_REPO_NODE_CACHE_TTL The default Time to live for nodes in the WLP Repository Node Cache. |
static String |
DEFAULT_REPO_TYPE_CACHE_IS_ENABLED The default value used to determine if the WLP Repository Type Cache is enabled. |
static String |
DEFAULT_REPO_TYPE_CACHE_MAX_ENTRIES The default number of types to cache in the WLP Repository Type Cache. |
static String |
DEFAULT_REPO_TYPE_CACHE_TTL The default Time to live for types in the WLP Repository Type Cache. |
static boolean |
DEFAULT_SEARCH_CACHE_ENABLED Default value to enable the search cache. |
static boolean |
DEFAULT_SEARCH_CACHE_IS_ENABLED Default value to enable the VCR search cache. |
static int |
DEFAULT_SEARCH_CACHE_MAX_ENTRIES Default value for the VCR search cache max-entries. |
static long |
DEFAULT_SEARCH_CACHE_TTL Default value for the VCR search cache time-to-live. |
static boolean |
DEFAULT_SEARCH_INDEXING_IS_ENABLED Default value to enable full-text search indexing support. |
static boolean |
DEFAULT_SEARCH_IS_ENABLED Default value to enable meta-data search query support. |
static String |
DEFAULT_SEARCH_OPS_HOME Deprecated No longer used. |
static boolean |
DEFAULT_TYPE_CACHE_IS_ENABLED Default value to enable the VCR type cache. |
static int |
DEFAULT_TYPE_CACHE_MAX_ENTRIES Default value for the VCR type cache max-entries. |
static long |
DEFAULT_TYPE_CACHE_TTL Default value for the VCR type cache time-to-live. |
static String |
EXPLICIT_CACHE_IS_ENABLED_KEY |
static String |
EXPLICIT_CACHE_MAX_ENTRIES_KEY Repository property keys for explicit properties cache |
static String |
EXPLICIT_CACHE_TTL_KEY |
static String |
FEDERATED_EVENTS_ENABLED_KEY used to determine if events are fired for this repository at the federated layer or not |
static String |
FILESYSTEM_CLASS_NAME The repository connection class for the WLP Filesystem Repository. |
static String |
FILESYSTEM_DIRECTORY_KEY the shared drive location of the file system |
static String |
FILESYSTEM_IS_LINKED used to see if the current file system is linked or not. |
static String |
FILESYSTEM_NIO whether or not we want to allow nio for a filesystem read |
static String |
FILESYSTEM_WEBAPP_KEY optional - the webapp location of the file system used by showBinaryServlet, getPropertyTag etc |
static String |
FOLDER_BADGES_KEY Used for third-party repositories to specify list of ObjectClasses that will represent a "badged folder". |
static String |
FULLTEXT_SEARCH_INDEX_LANGUAGE_TYPE_KEY The repository property key for the full text search index language type |
static String |
FULLTEXT_SEARCH_QUERY_ANY_LANGUAGE_KEY The repository property key for the full text search query any language setting |
static String |
FULLTEXT_SEARCH_QUERY_LANGUAGE_TYPE_KEY The repository property key for the full text search query language type |
static String |
MANAGEMENT_ENABLED_KEY The repository configuration property key to enable management (library services). |
static String |
PUBLIC_PROPERTY_PREFIX Any properties that have property names starting with this prefix will be available publicly (via IVirtualRepositoryManager.getPublicRepositoryConfig) |
static String |
REPO_BINARY_CACHE_IS_ENABLED_KEY The repository property key for the WLP Repository binary Cache Enabled flag. |
static String |
REPO_BINARY_CACHE_MAX_ENTRIES_KEY The repository property key for the WLP Repository binary Cache Max Entries value. |
static String |
REPO_BINARY_CACHE_MAX_ENTRY_SIZE_KEY The repository property key for the WLP Repository binary cache max entry size value. |
static String |
REPO_BINARY_CACHE_TTL_KEY The repository property key for the WLP Repository binary Cache TTL value. |
static String |
REPO_NODE_CACHE_IS_ENABLED_KEY The repository property key for the WLP Repository Node Cache Enabled flag. |
static String |
REPO_NODE_CACHE_MAX_ENTRIES_KEY The repository property key for the WLP Repository Node Cache Max Entries value. |
static String |
REPO_NODE_CACHE_TTL_KEY The repository property key for the WLP Repository Node Cache TTL value. |
static String |
REPO_TYPE_CACHE_IS_ENABLED_KEY The repository property key for the WLP Repository Type Cache Enabled flag. |
static String |
REPO_TYPE_CACHE_MAX_ENTRIES_KEY The repository property key for the WLP Repository Type Cache Max Entries value. |
static String |
REPO_TYPE_CACHE_TTL_KEY The repository property key for the WLP Repository Type Cache TTL value. |
static String |
REPO_VALIDATION_KEY The repository property key for repository validation. |
static String |
REPOSITORY_EVENTS_ENABLED_KEY used to determine if events are fired for this repository or not. |
static String |
SEARCH_ENGINE_MANAGER_KEY Used to define an implementation class of ISearchEngineManager. |
static String |
SEARCH_VALIDATION_KEY The repository property key for Search syntax validation. |
static String |
STREAMING_ENABLED_KEY The repository configuration property key to enable streaming. |
static String |
SUPPORTS_LIKE_ESCAPE_CLAUSE_KEY A boolean valued property to indicate whether the repo supports the backslash as an escape in a LIKE string. |
static String[] |
SYSTEM_PROPERTY_KEYS An array of the system property keys which can be set for a repository configuration. |
static String |
USE_NATIVE_SECURITY |
static String |
USE_RANGE_QUERIES |
static String |
VCR_VALIDATION_KEY The repository property key for VCR validation. |
static String |
WEBDAV_DREAMWEAVER_SUPPORT System Property key for WEBDAV_DREAMWEAVER_SUPPORT. |
Method Summary | |
---|---|
IRepositoryConfig |
clone() Clone this |
boolean |
getBinaryCacheIsEnabled() Gets the active state for the binary cache of a repository. |
int |
getBinaryCacheMaxEntries() Gets the max entries for the binary cache of a repository. |
long |
getBinaryCacheMaxEntrySize() Gets the max size for the binary cache of a repository. |
long |
getBinaryCacheTtl() Gets the time-to-live for entries in a binary cache of a repository. |
String |
getClassName() The class that implements com.bea.content.repostiory.Repository. |
String |
getFulltextSearchIndexLanguageType() Retrieves the full-text search index language type, or null if it is not set. |
boolean |
getFulltextSearchIsEnabled() Returns true if fulltext searches are allowed for this repository. |
Boolean |
getFulltextSearchQueryAnyLanguage() Retrieves the full-text-search query any lanuage setting, or null if it is not set. |
String |
getFulltextSearchQueryLanguageType() Retrieves the full-text search query language type, or null if it is not set. |
String |
getName() The name of the Repository. |
boolean |
getNodeCacheIsEnabled() Gets the active state for the node cache of a repository. |
int |
getNodeCacheMaxEntries() Gets the max entries for the node cache of a repository. |
long |
getNodeCacheTtl() Gets the time-to-live for entries in a node cache of a repository. |
String |
getPassword() Gets the password for the repository. |
Properties |
getProperties() Gets the configuration properties for the repository. |
boolean |
getReadOnly() Gets the read-only attribute for the repository. |
boolean |
getSearchCacheIsEnabled() Gets the active state for the search cache of a repository. |
int |
getSearchCacheMaxEntries() Gets the max entries for the search cache of a repository. |
long |
getSearchCacheTtl() Gets the time-to-live for entries in a search cache of a repository. |
boolean |
getSearchIndexingIsEnabled() Returns true if this repository will index items into its full text search index. |
boolean |
getSearchIsEnabled() Returns true if metadata searches are allowed for this repository. |
List<String> |
getSystemPropertyKeys() Return the default unmodifiable list of system property keys |
boolean |
getTypeCacheIsEnabled() Gets the active state for the type cache of a repository. |
int |
getTypeCacheMaxEntries() Gets the max entries for the type cache of a repository. |
long |
getTypeCacheTtl() Gets the time-to-live for entries in a type cache of a repository. |
String |
getUserName() Gets the username for the repository. |
boolean |
isManaged() True if this repository is versionable, false otherwise. |
boolean |
isStreamable() True if this repository has enabled streaming support for binary data. |
void |
setBinaryCacheIsEnabled(boolean binaryCacheIsEnabled) |
void |
setBinaryCacheMaxEntries(int binaryCacheMaxEntries) Sets the binary cache max entries |
void |
setBinaryCacheMaxEntrySize(long binaryCacheMaxEntrySize) Sets the binary cache max entry size in bytes. |
void |
setBinaryCacheTtl(long binaryCacheTtl) Sets the binary cache time to live |
void |
setClassName(String className) Set the className of the repository. |
void |
setFulltextSearchIsEnabled(boolean fulltextSearchIsEnabled) Sets whether or not this repository is fulltext searchable via the search API. |
void |
setNodeCacheIsEnabled(boolean nodeCacheIsEnabled) Sets whether or not the node cache is enabled for the repository |
void |
setNodeCacheMaxEntries(int nodeCacheMaxEntries) Sets the ndoe cache max entires for the repository |
void |
setNodeCacheTtl(long nodeCacheTtl) Sets the node cache time to live for the repo |
void |
setPassword(String password) Sets the password |
void |
setProperties(Properties properties) Sets the properties for the repository config |
void |
setReadOnly(boolean readOnly) Sets the readOnly attribute of the repository |
void |
setSearchIndexingIsEnabled(boolean searchIndexingIsEnabled) Sets whether or not this repository is indexing content into its full text search index. |
void |
setSearchIsEnabled(boolean searchIsEnabled) Sets whether or not this repository is metadata searchable via the search API. |
void |
setUserName(String userName) Sets the user name |
String |
toString() Gets attributes as String. |
Field Detail |
---|
static final String PUBLIC_PROPERTY_PREFIX
static final String DEFAULT_CLASS_NAME
static final String FILESYSTEM_CLASS_NAME
@Deprecated
static final String DEFAULT_OBJECT_CLASS_OPS_HOME
@Deprecated
static final String DEFAULT_NODE_OPS_HOME
@Deprecated
static final String DEFAULT_SEARCH_OPS_HOME
static final boolean DEFAULT_READ_ONLY
static final int DEFAULT_NODE_CACHE_MAX_ENTRIES
static final long DEFAULT_NODE_CACHE_TTL
static final boolean DEFAULT_NODE_CACHE_IS_ENABLED
static final int DEFAULT_TYPE_CACHE_MAX_ENTRIES
static final long DEFAULT_TYPE_CACHE_TTL
static final boolean DEFAULT_TYPE_CACHE_IS_ENABLED
static final int DEFAULT_SEARCH_CACHE_MAX_ENTRIES
static final long DEFAULT_SEARCH_CACHE_TTL
static final boolean DEFAULT_SEARCH_CACHE_IS_ENABLED
static final int DEFAULT_BINARY_CACHE_MAX_ENTRIES
static final long DEFAULT_BINARY_CACHE_MAX_ENTRY_SIZE
static final long DEFAULT_BINARY_CACHE_TTL
static final boolean DEFAULT_BINARY_CACHE_IS_ENABLED
static final boolean DEFAULT_SEARCH_IS_ENABLED
static final boolean DEFAULT_FULLTEXT_SEARCH_IS_ENABLED
static final boolean DEFAULT_SEARCH_INDEXING_IS_ENABLED
static final String FULLTEXT_SEARCH_INDEX_LANGUAGE_TYPE_KEY
static final String FULLTEXT_SEARCH_QUERY_LANGUAGE_TYPE_KEY
static final String FULLTEXT_SEARCH_QUERY_ANY_LANGUAGE_KEY
static final String WEBDAV_DREAMWEAVER_SUPPORT
static final boolean DEFAULT_SEARCH_CACHE_ENABLED
static final String DEFAULT_EXPLICIT_CACHE_MAX_ENTRIES
static final String DEFAULT_EXPLICIT_CACHE_TTL
static final String DEFAULT_EXPLICIT_CACHE_IS_ENABLED
static final String EXPLICIT_CACHE_MAX_ENTRIES_KEY
static final String EXPLICIT_CACHE_TTL_KEY
static final String EXPLICIT_CACHE_IS_ENABLED_KEY
static final String REPO_TYPE_CACHE_MAX_ENTRIES_KEY
static final String DEFAULT_REPO_TYPE_CACHE_MAX_ENTRIES
static final String REPO_TYPE_CACHE_TTL_KEY
static final String DEFAULT_REPO_TYPE_CACHE_TTL
static final String REPO_TYPE_CACHE_IS_ENABLED_KEY
static final String DEFAULT_REPO_TYPE_CACHE_IS_ENABLED
static final String REPO_NODE_CACHE_MAX_ENTRIES_KEY
static final String DEFAULT_REPO_NODE_CACHE_MAX_ENTRIES
static final String REPO_NODE_CACHE_TTL_KEY
static final String DEFAULT_REPO_NODE_CACHE_TTL
static final String REPO_NODE_CACHE_IS_ENABLED_KEY
static final String DEFAULT_REPO_NODE_CACHE_IS_ENABLED
static final String REPO_BINARY_CACHE_MAX_ENTRIES_KEY
static final String DEFAULT_REPO_BINARY_CACHE_MAX_ENTRIES
static final String REPO_BINARY_CACHE_MAX_ENTRY_SIZE_KEY
static final String DEFAULT_REPO_BINARY_CACHE_MAX_ENTRY_SIZE
static final String REPO_BINARY_CACHE_TTL_KEY
static final String DEFAULT_REPO_BINARY_CACHE_TTL
static final String REPO_BINARY_CACHE_IS_ENABLED_KEY
static final String DEFAULT_REPO_BINARY_CACHE_IS_ENABLED
static final String STREAMING_ENABLED_KEY
static final String MANAGEMENT_ENABLED_KEY
static final String FILESYSTEM_DIRECTORY_KEY
static final String FILESYSTEM_WEBAPP_KEY
static final String FILESYSTEM_IS_LINKED
static final String FILESYSTEM_NIO
static final String FEDERATED_EVENTS_ENABLED_KEY
static final String REPOSITORY_EVENTS_ENABLED_KEY
static final String SEARCH_ENGINE_MANAGER_KEY
static final String FOLDER_BADGES_KEY
static final String REPO_VALIDATION_KEY
static final String VCR_VALIDATION_KEY
static final String SEARCH_VALIDATION_KEY
static final String USE_RANGE_QUERIES
static final String USE_NATIVE_SECURITY
static final String SUPPORTS_LIKE_ESCAPE_CLAUSE_KEY
static final String[] SYSTEM_PROPERTY_KEYS
Method Detail |
---|
String getName()
String getClassName()
Properties getProperties()
String getUserName()
String getPassword()
boolean getReadOnly()
int getNodeCacheMaxEntries()
long getNodeCacheTtl()
boolean getNodeCacheIsEnabled()
int getTypeCacheMaxEntries()
long getTypeCacheTtl()
boolean getTypeCacheIsEnabled()
int getSearchCacheMaxEntries()
long getSearchCacheTtl()
boolean getSearchCacheIsEnabled()
int getBinaryCacheMaxEntries()
long getBinaryCacheMaxEntrySize()
long getBinaryCacheTtl()
boolean getBinaryCacheIsEnabled()
boolean getSearchIsEnabled()
boolean getFulltextSearchIsEnabled()
boolean getSearchIndexingIsEnabled()
String getFulltextSearchIndexLanguageType()
String getFulltextSearchQueryLanguageType()
Boolean getFulltextSearchQueryAnyLanguage()
boolean isManaged()
boolean isStreamable()
void setClassName(String className)
className
- The class namevoid setProperties(Properties properties)
properties
- The properties to set.void setUserName(String userName)
userName
- The username to set.void setPassword(String password)
password
- The password to set.void setReadOnly(boolean readOnly)
readOnly
- The readOnly bit for this repository.void setNodeCacheMaxEntries(int nodeCacheMaxEntries)
nodeCacheMaxEntries
- The maxinum cache entries for the node cache for this repository.void setNodeCacheIsEnabled(boolean nodeCacheIsEnabled)
nodeCacheIsEnabled
- True if enabling the node cache, else false.void setNodeCacheTtl(long nodeCacheTtl)
nodeCacheTtl
- The time-to-live value for entries in this repository's node cache.void setBinaryCacheMaxEntries(int binaryCacheMaxEntries)
binaryCacheMaxEntries
- The maximum number of entires in this repository's binary cache.void setBinaryCacheMaxEntrySize(long binaryCacheMaxEntrySize)
binaryCacheMaxEntrySize
- The maximum size of an entry for this repository's binary cache.void setBinaryCacheTtl(long binaryCacheTtl)
binaryCacheTtl
- The time-to-live value for entries in this repository's binary cache.void setBinaryCacheIsEnabled(boolean binaryCacheIsEnabled)
void setSearchIsEnabled(boolean searchIsEnabled)
searchIsEnabled
- True if metadata search is enabled for this repository.void setFulltextSearchIsEnabled(boolean fulltextSearchIsEnabled)
fulltextSearchIsEnabled
- True if fulltext search is enabled for this repository.void setSearchIndexingIsEnabled(boolean searchIndexingIsEnabled)
searchIndexingIsEnabled
- True if fulltext search indexing is enabled for this repository.String toString()
toString
in class Object
IRepositoryConfig clone() throws CloneNotSupportedException
CloneNotSupportedException
List<String> getSystemPropertyKeys()
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.