# com.bea.p13n.mbeans
DocumentManagerMBean Interface

public interface DocumentManagerMBean
extends `ServiceConfigurationMBean`

The DocumentManager management bean interface.

A deployed DocumentManager EJB will look for a DocumentManagerMBean whose name corresponds to the "DocumentManagerMBeanName" environment setting of the EJB.

All Superinterfaces
  `ConfigurationMBean`, `DynamicMBean`, `MBeanRegistration`, `NotificationBroadcaster`, `ServiceConfigurationMBean`, `WebLogicMBean`

## Field Summary

Fields from interface weblogic.management.configuration`.`ConfigurationMBean``
`CACHING_STUB_SVUID, DEFAULT_EMPTY_BYTE_ARRAY`

## Method Summary

`public `String`` | `getContentCacheName`() Get the name of the cache to use for caching document content.
`public `String`` | `getDocumentConnectionPoolName`() Get the name of the DocumentConnectionPool this should use.
`public `String`` | `getJNDIName`() Get the DocumentManager EJB JNDI name for this document manager.
`public int` | `getMaxCachedContentSize`() Get the maximum size of a document content block to cache.
`public `String`` | `getMetadataCacheName`() Get the name of the cache to use for caching document metadata.
`public `String`` | `getPropertyCase`() Get the case of properties for this DocumentManager The value should one of "lower", "upper", or "none".
`public boolean` | `getSynchronizedAccess`() Should we serialize search and content byte access to the underlying `DocumentProvider```?
`public boolean` | `isContentCaching`() Should the DocumentManager cache document content.
`public boolean` | `isMetadataCaching`() Should the DocumentManager cache document metadata.
`public boolean` | `isUserIdInCacheKey`() Should we use the userId as part of the cache key.
`public void` | `setContentCacheName`(`String` name) Set the name of the cache to use for caching document content.
`public void` | `setContentCaching`(boolean b) Set if the DocumentManager cache document content.
`public void` | `setDocumentConnectionPoolName`(`String` name) Set the name of the DocumentConnectionPool this should use.
`public void` | `setJNDIName`(`String` name) Set the DocumentManager EJB JNDI name for this document manager.
`public void` | `setMaxCachedContentSize`(int size) Set the maximum size of a document content block to cache.
`public void` | `setMetadataCacheName`(`String` name) Get the name of the cache to use for caching document metadata.
`public void` | `setMetadataCaching`(boolean b) Set if the DocumentManager cache document metadata.
`public void` | `setPropertyCase`(`String` c) Get the case of properties for this DocumentManager The value should one of "lower", "upper", or "none".
`public void` | `setSynchronizedAccess`(boolean b) Should we serialize search and content byte access to the underlying `DocumentProvider```?
`public void` | `setUserIdInCacheKey`(boolean b) Should we use the userId as part of the cache key.

Methods from interface `weblogic.management.configuration.`ConfigurationMBean``
`freezeCurrentValue, getAttributeStringValue, getComments, getNotes, getSetFields, getXml, getXmlConverter, isDefaultedMBean, isPersistenceEnabled, preDeregister, registerConfigMBean, restoreDefaultValue, setComments, setDefaultedMBean, setNotes, setPersistenceEnabled, touch, unRegisterConfigMBean`

Methods from interface `javax.management.`DynamicMBean``
`getAttribute, getAttributes, getMBeanInfo, invoke, setAttribute, setAttributes`

Methods from interface `javax.management.`MBeanRegistration``
`postDeregister, postRegister, preDeregister, preRegister`

Methods from interface `javax.management.`NotificationBroadcaster``
`addNotificationListener, getNotificationInfo, removeNotificationListener`

Methods from interface `com.bea.p13n.management.`ServiceConfigurationMBean``
``

Methods from interface `weblogic.management.`WebLogicMBean``
`getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent`

## Method Detail

### getContentCacheName() Method

    public String getContentCacheName()

Get the name of the cache to use for caching document content.

### getDocumentConnectionPoolName() Method

    public String getDocumentConnectionPoolName()

Get the name of the DocumentConnectionPool this should use.

### getJNDIName() Method

    public String getJNDIName()

Get the DocumentManager EJB JNDI name for this document manager.

This will be used by the `PropertySetRepositoryImpl``` from the PropertySetManager to find additional ContentManagers to fetch CONTENT property sets from.

### getMaxCachedContentSize() Method

    public int getMaxCachedContentSize()

Get the maximum size of a document content block to cache.

### getMetadataCacheName() Method

    public String getMetadataCacheName()

Get the name of the cache to use for caching document metadata.

### getPropertyCase() Method

    public String getPropertyCase()

Get the case of properties for this DocumentManager

The value should one of "lower", "upper", or "none".

### getSynchronizedAccess() Method

    public boolean getSynchronizedAccess()

Should we serialize search and content byte access to the underlying `DocumentProvider```?

Set this to true if the DocumentProvider implementation is very resource or time intensive. If this is set to true, you should be sure caching is enabled to avoid serializing all access to the EJB to a time-intensive method.

Related Topics

``DocumentManagerMBean.setMetadataCaching(boolean)``
``DocumentManagerMBean.setContentCaching(boolean)``

### isContentCaching() Method

    public boolean isContentCaching()

Should the DocumentManager cache document content.

### isMetadataCaching() Method

    public boolean isMetadataCaching()

Should the DocumentManager cache document metadata.

### isUserIdInCacheKey() Method

    public boolean isUserIdInCacheKey()

Should we use the userId as part of the cache key.

### setContentCacheName(String) Method

    public void setContentCacheName(String name)

Set the name of the cache to use for caching document content.

### setContentCaching(boolean) Method

    public void setContentCaching(boolean b)

Set if the DocumentManager cache document content.

### setDocumentConnectionPoolName(String) Method

    public void setDocumentConnectionPoolName(String name)

Set the name of the DocumentConnectionPool this should use.

### setJNDIName(String) Method

    public void setJNDIName(String name)

Set the DocumentManager EJB JNDI name for this document manager.

This will be used by the `PropertySetRepositoryImpl``` from the PropertySetManager to find additional ContentManagers to fetch CONTENT property sets from.

### setMaxCachedContentSize(int) Method

    public void setMaxCachedContentSize(int size)

Set the maximum size of a document content block to cache.

### setMetadataCacheName(String) Method

    public void setMetadataCacheName(String name)

Get the name of the cache to use for caching document metadata.

### setMetadataCaching(boolean) Method

    public void setMetadataCaching(boolean b)

Set if the DocumentManager cache document metadata.

### setPropertyCase(String) Method

    public void setPropertyCase(String c)

Get the case of properties for this DocumentManager

The value should one of "lower", "upper", or "none".

### setSynchronizedAccess(boolean) Method

    public void setSynchronizedAccess(boolean b)

Should we serialize search and content byte access to the underlying `DocumentProvider```?

Set this to true if the DocumentProvider implementation is very resource or time intensive. If this is set to true, you should be sure caching is enabled to avoid serializing all access to the EJB to a time-intensive method.

### setUserIdInCacheKey(boolean) Method

    public void setUserIdInCacheKey(boolean b)

Should we use the userId as part of the cache key.