Package com.webmethods.portal.mech.storage

Interface IContentMechanics

All Superinterfaces:

IAccessMechanics, IBasicMechanics, IClipboardMechanics, IComponent, IInitializable, IMechanics, ISubscribableMechanics, ISystemHandler, IVersionableMechanics, IViewableMechanics

public interface IContentMechanics
extends IVersionableMechanics

IContentMechanics - Content services mechanics. This one is used to operate with content services. See IContentService

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_CONTENT	This property identifies original file name for published content object.
static final String	PROP_CONTENT_LENGTH	This property specifies the length (in bytes) of the content file See ContentMechanics.create(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, java.util.Map<java.lang.String, ? extends java.lang.Object>, java.util.Locale)
static final String	PROP_CONTENT_MIME_TYPE	This property identifies the mime encoding of the content file.
static final String	PROP_CONTENT_URI	This property identifies the URI of the content within the content store.
static final String	PROP_CONTENT_VERSIONED	This property identifies if the content is versioned See ContentMechanics.create(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, java.util.Map<java.lang.String, ? extends java.lang.Object>, java.util.Locale)

Fields inherited from interface com.webmethods.portal.mech.access.IAccessMechanics

ACCESS_DENIED, ACCESS_GRANTED, ACCESS_RIGHT_ID, ACCESS_RIGHT_LONG_NAME, ACCESS_RIGHT_SHORT_NAME, ACCESS_RIGHTS_CONTAINER, ACCESS_UNSPECIFIED, AUTH_LEVEL_ANONYMOUS, AUTH_LEVEL_BASIC, AUTH_LEVEL_DEFAULT, AUTH_LEVEL_FULL_ACCESS, AUTH_LEVEL_KERBEROS, AUTH_LEVEL_NTLM, AUTH_LEVEL_PROPERTY

Fields inherited from interface com.webmethods.portal.mech.storage.IBasicMechanics

PROP_CUSTOM_FILE_ENCODING, PROP_FILE_ENCODING, TITLEBAR_ACTION_SHOW_ADD_TO_HOME, TITLEBAR_ACTION_SHOW_DISPLAY_OPTIONS, TITLEBAR_ACTION_SHOW_MAXIMIZED, TITLEBAR_ACTION_SHOW_MINIMIZED, TITLEBAR_ACTION_SHOW_NORMAL

Fields inherited from interface com.webmethods.portal.mech.subscription.ISubscribableMechanics

CONTENT_FORMAT_EMAIL, CONTENT_FORMAT_EMAIL_DIGEST, CONTENT_FORMAT_PORTAL_INBOX, CONTENT_FORMAT_PORTAL_INBOX_DIGEST, HEADER_FROM, HEADER_SUBJECT, HEADER_TO

Fields inherited from interface com.webmethods.portal.mech.view.IViewableMechanics

COMMENTS_LINK_TYPE, CONTENT_LINK_TYPE, DEFAULT_ORDER, DEFAULT_PAGE_SIZE, DEFAULT_SORT, DETAILS_LINK_TYPE, LARGE_ICON_TYPE, LINK_TYPE, LINK_TYPE_COMMENTS, LINK_TYPE_CONTENT, LINK_TYPE_DETAILS, LINK_TYPE_EDIT, LINK_TYPE_HELP, LINK_TYPE_HELP_MAXIMIZED, LINK_TYPE_MAXIMIZED, LINK_TYPE_MINIMIZED, LINK_TYPE_PERMISSIONS, LINK_TYPE_PORTAL_CONTENT, LINK_TYPE_PORTLET_STANDALONE, LINK_TYPE_PROPERTIES, LINK_TYPE_RESTORED, LINK_TYPE_SUBSCRIPTIONS, LINK_TYPE_THUMBNAILS, LINK_TYPE_VERSIONS, PERMISSIONS_LINK_TYPE, PORTAL_CONTENT_LINK_TYPE, PROPERTIES_LINK_TYPE, PROPERTY_LINK_TARGET, PROPERTY_OWNER_NAME, PROPERTY_PARENT_NAME, PROPERTY_TOOLTIP, REFERENCE_ICON_TYPE, SUBSCRIPTIONS_LINK_TYPE, THUMBNAIL_ICON_TYPE, THUMBNAILS_LINK_TYPE, VERSIONS_LINK_TYPE

Method Summary

Modifier and Type	Method	Description
IPortalFileBean	createFileBean(String key, InputStream inStream, String filename, String contentType, boolean insoConvert)	Factory method to create a instance of the IPortalFileBean
IPortalFileBean	createFileBean(String key, String fullFileName, String filename, String contentType, boolean insoConvert)	Factory method to create a instance of the IPortalFileBean
IContentService	getService(IThingID itemId)	Returns the IContentService appropriate for the specified thing.
IListView<IContentService>	getServices(IPagingCookie cookie)	Get a viewable list of content services
void	registerServiceWithMetadata(String serviceName)	Register the service with the metadata system.

Methods inherited from interface com.webmethods.portal.mech.access.IAccessMechanics

canRemoveSecurityRealm, canSetSecurityRealm, checkAccess, checkAccessEx, checkRemoveSecurityRealm, checkSetSecurityRealm, cloneAces, fireRemoveAcccesEvent, fireRemoveSecurityRealmEvent, fireSetAccessEvent, fireSetAuthenticationEvent, fireSetOwnerEvent, fireSetSecurityRealmEvent, getAccessEx, getAccessList, getAccessListEx, getAclView, getAuthLevelForAuthScheme, getAuthScheme, getAuthSchemeForAuthLevel, getAuthSchemeForResource, getAvailableAuthSchemes, getDefaultAuthScheme, getRightNameForValue, getRightsForType, getRightValueForName, getSecurityRealm, invalidateAcesForThing, invalidateAcesForUser, listSecurityRealmObjects, removeAces, removeSecurityRealm, setAces, setAcesEx, setSecurityRealm, setSecurityRealm

Methods inherited from interface com.webmethods.portal.mech.storage.IBasicMechanics

addNote, addReference, addRelation, canAddNote, canCloneRemote, canCreate, canDelete, canDestroy, canDoTitlebarAction, canListAccess, canListContainers, canListNotes, canRemoveAccess, canRemoveNote, canSetAccess, canSetAuthentication, canSetOwner, canUninstall, canUpdateContent, canUpdateProperties, canVerb, canViewAuthentication, canViewContent, checkAddNote, checkCloneRemote, checkCreate, checkDelete, checkDestroy, checkListAccess, checkListContainers, checkListNotes, checkRemoveAccess, checkRemoveNote, checkSetAccess, checkSetAuthentication, checkSetOwner, checkUninstall, checkUpdateContent, checkUpdateProperties, checkViewAuthentication, checkViewContent, cloneRemote, copy, create, create, delete, destroy, doAfterInstall, doAfterUpgrade, doBeforeUninstall, doBeforeUpgrade, fireAddNoteEvent, fireCacheInvalidateEvent, fireDeleteEvent, fireInsoEvent, fireListAccessEvent, fireListContainersEvent, fireListNotesEvent, firePurgeEvent, fireRemoveAcccesEvent, fireRemoveNoteEvent, fireSetAccessEvent, fireSetAuthenticationEvent, fireSetOwnerEvent, fireUpdateContentEvent, fireUpdatePropertiesEvent, fireViewAuthenticationEvent, fireViewContentEvent, getAccess, getAncestors, getAuthentication, getContent, getContent, getContentStore, getContentStore, getDependencyList, getPrimaryRelatedChild, getPrimaryRelatedContainer, getTimeToLive, isAnonymous, isBaseType, isContainer, isNormal, isReference, isVersionable, isWorkflowEnabled, listAccess, listAccess, listContainers, listContainers, listDependants, listNotes, listRelatedChildren, listRelatedContainers, move, move, prepareForDeletion, removeNote, removeReference, removeRelation, restoreXTypeConfProps, saveXTypeConfProps, setAuthentication, setOwner, setTimeToLive, undeleteAllUndestroyed, updateContent, updateContent, updateProperties, updateProperties

Methods inherited from interface com.webmethods.portal.mech.clipboard.IClipboardMechanics

canCopyToClipboard, canCutToClipboard, checkCopyToClipboard, checkCutToClipboard, copyToClipboard, cutToClipboard, getClipboard, getClipboardInfo, newClipboardItem

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.mech.subscription.ISubscribableMechanics

canDeliverToPrincipal, canEditSubscription, canListSubscriptions, canViewSubscription, checkEditSubscription, checkListSubscriptions, checkViewSubscription, checkViewSubscription, createAppCriteria, createAppCriteriaFolder, createPortletSubscription, createPortletSubscription, disable, disable, disableBySystem, disableBySystem, enable, enable, fireGetAppCriteriaEvent, fireGetSubscriptionEvent, fireSetSubscriptionEvent, fireUnsubscribeEvent, fireViewSubscriptionEvent, generateNotificationContent, generateNotificationHeaders, getAppCriteria, getGroupSubscription, getSubscription, listSubscriptions, listSubscriptions, setGroupSubscription, setGroupSubscription, setSubscription, setSubscription, unsubscribe, unsubscribe, viewSubscription

Methods inherited from interface com.webmethods.portal.mech.storage.IVersionableMechanics

addToVersioning, canAddToVersioning, canCheckIn, canCheckOut, canListVersions, canPublishVersion, canRemoveFromVersioning, canSetCurrentVersion, canUndoCheckOut, canViewVersion, checkAddToVersioning, checkCheckIn, checkCheckOut, checkIn, checkListVersions, checkOut, checkPublishVersion, checkRemoveFromVersioning, checkSetCurrentVersion, checkUndoCheckOut, checkViewVersion, fireAddToVersioningEvent, fireCheckInEvent, fireCheckOutEvent, fireListVersionsEvent, firePublishVersionEvent, fireRemoveFromVersioningEvent, fireSetCurrentVersionEvent, fireUndoCheckOutEvent, fireViewVersionEvent, getCheckedOutBy, getVersion, isCheckedOut, isVersioned, listVersions, publishVersion, removeFromVersioning, setCurrentVersion, undoCheckOut, viewVersion

Methods inherited from interface com.webmethods.portal.mech.view.IViewableMechanics

canView, checkView, createPagingCookie, fireViewEvent, getCss, getCss, getDefaultLinkType, getFormattedProperty, getHierachicalUri, getIcon, getIcon, getLink, getLink, getListProperty, getListPropertyHTML, getListPropertyJS, isEnabled, view, view

Field Details

PROP_CONTENT

static final String PROP_CONTENT

This property identifies original file name for published content object. See ContentMechanics.create(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, java.util.Map<java.lang.String, ? extends java.lang.Object>, java.util.Locale)

See Also:

• Constant Field Values

PROP_CONTENT_URI

static final String PROP_CONTENT_URI

This property identifies the URI of the content within the content store. See ContentMechanics.create(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, java.util.Map<java.lang.String, ? extends java.lang.Object>, java.util.Locale)

See Also:

• Constant Field Values

PROP_CONTENT_VERSIONED

static final String PROP_CONTENT_VERSIONED

This property identifies if the content is versioned See ContentMechanics.create(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, java.util.Map<java.lang.String, ? extends java.lang.Object>, java.util.Locale)

See Also:

• Constant Field Values

PROP_CONTENT_LENGTH

static final String PROP_CONTENT_LENGTH

This property specifies the length (in bytes) of the content file See ContentMechanics.create(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, java.util.Map<java.lang.String, ? extends java.lang.Object>, java.util.Locale)

See Also:

• Constant Field Values

PROP_CONTENT_MIME_TYPE

static final String PROP_CONTENT_MIME_TYPE

This property identifies the mime encoding of the content file. See ContentMechanics.create(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, java.util.Map<java.lang.String, ? extends java.lang.Object>, java.util.Locale)

See Also:

• Constant Field Values

Method Details

getService

IContentService getService(IThingID itemId)
                    throws PortalException

Returns the IContentService appropriate for the specified thing. If the appropriate service is indeterminate, returns the default service.

Parameters:

itemId - content object thing ID. This has to be an IContent object

Returns:

instance of IContentService or null

Throws:

PortalException

getServices

IListView<IContentService> getServices(IPagingCookie cookie)
                                throws PortalException

Get a viewable list of content services

Parameters:

cookie - IPagingCookie to be applied to result view. This parameter may be null

Returns:

ListView of all content services registered in the system

Throws:

PortalException

registerServiceWithMetadata

void registerServiceWithMetadata(String serviceName)
                          throws PortalException

Register the service with the metadata system. Records the services configuration files into the database. For internal use only.

Parameters:

serviceName - the name of the content service

Throws:

PortalException

createFileBean

IPortalFileBean createFileBean(String key,
 InputStream inStream,
 String filename,
 String contentType,
 boolean insoConvert)
                        throws PortalException

Factory method to create a instance of the IPortalFileBean

Returns:

a new IPortalFileBean instance

Throws:

PortalException

createFileBean

IPortalFileBean createFileBean(String key,
 String fullFileName,
 String filename,
 String contentType,
 boolean insoConvert)

Factory method to create a instance of the IPortalFileBean

Returns:

a new IPortalFileBean instance

Throws:

PortalException