com.webmethods.portal.service.content

Interface IContentService

All Superinterfaces:

IComponent, IInitializable, IView, Serializable

public interface IContentService
extends IComponent, IView

IContentService - Interface for content services. Defines functions to operate with content files

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_SERVICE_RESET_FLAG 'webmethods.service.content.reset' System property that controls if content services configuration should be reset from storageConfig.xml config file.
static String	PROP_AVAILABLE Service view property: identifies if content service in online at that time.
static String	PROP_DEFAULT Service view property: identifies if content service is default service.
static String	PROP_ROOT Service view property: root folder for content service.
static String	PROPERTIES_ROOT_NAME Identifies content service configuration XML root property - where content service root folder value is stored

Fields inherited from interface com.webmethods.portal.service.view.IView

PROP_DESCRIPTION, PROP_NAME, PROP_TYPE, PROP_URI

Method Summary

Modifier and Type	Method and Description
IContentURI	acquireURI(IURI uri) Acquires the normal content uri implementation for the specified string uri.
IContentURI	acquireURI(String uri) Acquires a uri implementation for the specified string uri.
IContentURI	bind(IURI name, IContentStore content) Binds content store to a Uri.
IContentURI	bindAsync(IURI name, IContentStore content, IContentEventListener eventListener) Binds content to a name asynchronously.
IContentService	cloneService() Clones this service
IContentURI	copy(IURI from, IURI to, String[] mimeTypes) Copies contents from uri to uri.
IContentStore	createContent() Creates empty content store object for this service
void	createRoot(IURI name) Pre-creates root folder specified by name.
boolean	destroy(IURI name) Destroy content in repository.
void	destroyRoot(IURI name) Destroys root folder for specified uri.
boolean	enableNotification(int listenerToken, boolean enable) Enable/disable events notification for registered listener
IURI	generateContentURI(String key1, String key2) Creates a content URI based off the key which should be the thing name
String	getContentServiceName() Returns content name
boolean	isAvailable() Checks if content server available
IContentURI[]	listContents(IURI root) Enumerates all content URI under specified root URI
IContentURI[]	listRoots(IURI root) Enumerates all roots URIs under specified root URI
IContentStore	lookup(IURI name) Looks up IContentStore by its uri
IContentStore	lookup(IURI name, String mime) Looks up for content by both name and mime type Use this function when several mime types were bound to the the URI
int	registerEventListener(Object eventListener) Registers event listener object to be notified for Content server operations
void	unregisterEventListener(Object eventListener) Unregisters event listener object to be notified for Content server operations
void	updateConfiguration(IThingID serviceID, Element configElem)

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Methods inherited from interface com.webmethods.portal.service.view.IView

getProperties, getProperty, getPropertyNames, getURI

Field Detail

PROP_DEFAULT

static final String PROP_DEFAULT

Service view property: identifies if content service is default service. See IContentMechanics.getServices(com.webmethods.portal.service.view.IPagingCookie)

See Also:

Constant Field Values

PROP_AVAILABLE

static final String PROP_AVAILABLE

Service view property: identifies if content service in online at that time. See IContentMechanics.getServices(com.webmethods.portal.service.view.IPagingCookie)

See Also:

Constant Field Values

PROP_ROOT

static final String PROP_ROOT

Service view property: root folder for content service. See IContentMechanics.getServices(com.webmethods.portal.service.view.IPagingCookie)

See Also:

Constant Field Values

CONTENT_SERVICE_RESET_FLAG

static final String CONTENT_SERVICE_RESET_FLAG

'webmethods.service.content.reset' System property that controls if content services configuration should be reset from storageConfig.xml config file. Possible values are 'true' and 'false'

See Also:

Constant Field Values

PROPERTIES_ROOT_NAME

static final String PROPERTIES_ROOT_NAME

Identifies content service configuration XML root property - where content service root folder value is stored

See Also:

Constant Field Values

Method Detail

createContent

IContentStore createContent()
                     throws MetaException

Creates empty content store object for this service

Returns:

instance of IContentStore

Throws:

MetaException

bind

IContentURI bind(IURI name,
                 IContentStore content)
          throws MetaException

Binds content store to a Uri.

Parameters:

name - - unique URI for this content. This should be in a form of file path: /segment1/segment2/.../filename.ext

content - object representing content to be bound

Returns:

a fully qualified Uri for the object to that contains identification of the service to be used. This Uri could be used to lookup IContentStore directly using PortalSystem.lookup(com.webmethods.portal.system.IURI) method

Throws:

MetaException

bindAsync

IContentURI bindAsync(IURI name,
                      IContentStore content,
                      IContentEventListener eventListener)
               throws MetaException

Binds content to a name asynchronously. Returns immediately.

Parameters:

name - - unique URI for this content. This should be in a form of file path: /segment1/segment2/.../filename.ext

content - object representing content to be bound

eventListener - registered object to be notified upon operation completion

Returns:

a fully qualified Uri for the object to that contains identification of the service to be used. This Uri could be used to lookup IContentStore directly using PortalSystem.lookup(com.webmethods.portal.system.IURI) method

Throws:

MetaException

lookup

IContentStore lookup(IURI name)
              throws MetaException

Looks up IContentStore by its uri

Parameters:

name - unique URI for content

Returns:

contentstore for specified URI, or null of content is not found

Throws:

MetaException

lookup

IContentStore lookup(IURI name,
                     String mime)
              throws MetaException

Looks up for content by both name and mime type Use this function when several mime types were bound to the the URI

Parameters:

name - unique URI for content

mime - mime type of content to lookup. This value will override any mime type specified directly in the content uri. This parameter may be null.

Returns:

contentstore for specified URI, or null of content is not found

Throws:

MetaException

copy

IContentURI copy(IURI from,
                 IURI to,
                 String[] mimeTypes)
          throws MetaException

Copies contents from uri to uri. Optionally may copy only specified mime types passed in mimeTypes

Parameters:

from - source uri

to - target uri

mimeTypes - list of mime types to copy. This parameter may be null, in this case all mime types are copied.

Throws:

MetaException

createRoot

void createRoot(IURI name)
         throws MetaException

Pre-creates root folder specified by name. Doesn't bind anything

Parameters:

name - folder uri to create

Throws:

MetaException

destroy

boolean destroy(IURI name)
         throws MetaException

Destroy content in repository.

Parameters:

name - unique URI for content

Returns:

true if content was sucessfully deleted

Throws:

MetaException

destroyRoot

void destroyRoot(IURI name)
          throws MetaException

Destroys root folder for specified uri. Effectively destroys all mime types as well stored under this uri

Parameters:

name - unique URI for content

Throws:

MetaException

generateContentURI

IURI generateContentURI(String key1,
                        String key2)
                 throws MetaException

Creates a content URI based off the key which should be the thing name

Parameters:

key1 - name of thing

key2 - DB ID of thing

Returns:

content URI for the key

Throws:

MetaException

listRoots

IContentURI[] listRoots(IURI root)
                 throws MetaException

Enumerates all roots URIs under specified root URI

Parameters:

root - URI for the root key. May be empty to enumerate roots under service root

Returns:

list of root URIs

Throws:

MetaException

listContents

IContentURI[] listContents(IURI root)
                    throws MetaException

Enumerates all content URI under specified root URI

Parameters:

root - URI for the root key. May be empty to enumerate roots under service root

Returns:

list of content URIs

Throws:

MetaException

registerEventListener

int registerEventListener(Object eventListener)
                   throws MetaException

Registers event listener object to be notified for Content server operations

Returns:

unique token for registered listener

Throws:

MetaException

unregisterEventListener

void unregisterEventListener(Object eventListener)
                      throws MetaException

Unregisters event listener object to be notified for Content server operations

Parameters:

eventListener - instance of event listener for asynchronous bind operation

Throws:

MetaException

enableNotification

boolean enableNotification(int listenerToken,
                           boolean enable)
                    throws MetaException

Enable/disable events notification for registered listener

Parameters:

listenerToken - unique listener token returned by RegisterEventListener

enable - flag to enable/disable notification for this listener

Returns:

previous state

Throws:

MetaException

cloneService

IContentService cloneService()
                      throws MetaException

Clones this service

Returns:

cloned content service

Throws:

MetaException

isAvailable

boolean isAvailable()

Checks if content server available

Returns:

true if content service is online

getContentServiceName

String getContentServiceName()

Returns content name

Returns:

content service name

acquireURI

IContentURI acquireURI(String uri)

Acquires a uri implementation for the specified string uri.

Parameters:

uri -

Returns:

acquireURI

IContentURI acquireURI(IURI uri)

Acquires the normal content uri implementation for the specified string uri.

Parameters:

uri - uri for content item

Returns:

valid IContentURI that reprensent original uri

updateConfiguration

void updateConfiguration(IThingID serviceID,
                         Element configElem)
                  throws MetaException

Throws:

MetaException