oracle.workspaces.resource.email
Class CwEmailResource

java.lang.Object
oracle.workspaces.resource.CwResource
oracle.workspaces.resource.email.CwEmailResource

All Implemented Interfaces:

CwExceptionConstants

public class CwEmailResource

extends CwResource

implements CwExceptionConstants

The resource representing the Workspace Inbox functionality. Note that this resource is built upon the threaded discussions component (which is built upon Oracle Email) and therefore shares a lot of classes with the Workspaces discussion resource. Behind the scenes, each Inbox resource maps to a discussions board/forum.

Field Summary

static java.lang.String	CW_EMAIL_SUBSCRIPTION_POLICY_NAME
static int	EMAIL_INBOUND_NONE Policy constant prohibiting inbound email to the inbox.
static int	EMAIL_INBOUND_OPEN Policy constant allowing inbound email from any user.
static int	EMAIL_INBOUND_RESTRICTED Policy constant restricting inbound email to users with write privilege to the inbox.
static java.lang.String	SUBSCRIPTION_POLICY_DISABLED Policy constant for disabling subscription to the inbox.
static java.lang.String	SUBSCRIPTION_POLICY_ENABLED Policy constant for enabling subscription to the inbox.

Fields inherited from interface oracle.workspaces.exmsgs.CwExceptionConstants

CW_ADD_NONPARENTMEMBER_TO_SUBWSPC, CW_ANNOUNCEMENT_NOT_FOUND, CW_ASSERTION_ERROR, CW_ASSOCIATION_NOT_FOUND, CW_ATTACHMENT_ARRAY_PARAMS_MISMATCH, CW_ATTACHMENTS_CONTAINER_ERROR, CW_ATTR_SYNTAX_VIOLATION_BODY, CW_ATTR_SYNTAX_VIOLATION_DESCRIPTION, CW_ATTR_SYNTAX_VIOLATION_DISPLAY_NAME, CW_ATTR_SYNTAX_VIOLATION_HOSTNAME, CW_ATTR_SYNTAX_VIOLATION_LOCATION, CW_ATTR_SYNTAX_VIOLATION_NAME, CW_ATTR_SYNTAX_VIOLATION_NON_ASCII_NAME, CW_ATTR_SYNTAX_VIOLATION_NON_ASCII_WORKSPACE_NAME, CW_ATTR_SYNTAX_VIOLATION_PATH, CW_ATTR_SYNTAX_VIOLATION_PORT, CW_ATTR_SYNTAX_VIOLATION_TITLE, CW_ATTR_SYNTAX_VIOLATION_WHITESPACE, CW_ATTR_VAL_INVALID_DISPLAYNAME_DUPLICATION, CW_ATTR_VAL_INVALID_NAME_DUPLICATION, CW_ATTR_VAL_INVALID_NAME_MISSING, CW_ATTR_VAL_INVALID_RSRC_TYPE_DUPLICATION, CW_ATTR_VAL_INVALID_RSRC_TYPE_MISSING, CW_ATTR_VAL_INVALID_TOKEN_NAME_BODY_EXST, CW_ATTR_VAL_INVALID_TOKEN_NAME_BODY_NEW, CW_ATTR_VAL_INVALID_TOKEN_NAME_BODY_REM, CW_ATTR_VAL_INVALID_TOKEN_NAME_BODY_RMV, CW_ATTR_VAL_INVALID_TOKEN_NAME_SUB_EXST, CW_ATTR_VAL_INVALID_TOKEN_NAME_SUB_NEW, CW_ATTR_VAL_INVALID_TOKEN_NAME_SUB_REM, CW_ATTR_VAL_INVALID_TOKEN_NAME_SUB_RMV, CW_CALENDAR_ATLEAST_ONE_ATTENDEE, CW_CALENDAR_ATTENDEE_NOT_FOUND, CW_CALENDAR_CANNOT_BOOK_ATTENDEE_EXCEPTION, CW_CALENDAR_CONFIGURATION_EXCEPTION, CW_CALENDAR_CORRUPTED_EXCEPTION, CW_CALENDAR_CREATE_WEBCONF_PAST_EXCEPTION, CW_CALENDAR_EVENT_ALREADY_EXIST, CW_CALENDAR_EVENT_NOT_FOUND, CW_CALENDAR_HANDLE_BAD_EXCEPTION, CW_CALENDAR_INTERNAL_EXCEPTION, CW_CALENDAR_ITEM_NOT_FOUND, CW_CALENDAR_PROVISION_EXCEPTION, CW_CALENDAR_QUOTA_LIMIT_EXCEPTION, CW_CALENDAR_SESSION_INVALID, CW_CALENDAR_SESSION_INVALID_WITH_WARNING, CW_CALENDAR_TASK_ALREADY_EXIST, CW_CALENDAR_TASK_NOT_FOUND, CW_CALENDAR_UNAVAILABLE_EXCEPTION, CW_CALENDAR_UNSUPPORTED_FOR_REGULAR, CW_CALENDAR_UNSUPPORTED_FOR_REPEATING, CW_CALENDAR_UNSUPPORTED_FOR_TYPE, CW_CANNOT_EDIT_READ_ONLY, CW_CANNOT_REASSIGN_WORKSPACE_OWNER_ROLE, CW_CONFIGURATION_PROPERTY_NOT_FOUND, CW_COULD_NOT_CREATE_CONTENT_SERVICES_CW_ADMIN, CW_DB_CONNECTION_ERROR, CW_DB_EXEC_INTERNAL_ERROR, CW_DEFAULT_PROPERTIES_FILE_CANNOT_BE_LOADED, CW_DEFAULT_WORKSPACE_TEMPLATE_CANNOT_BE_DELETED, CW_DELETE_WORKSPACE_OWNER, CW_DELETE_WORKSPACE_WITH_CHILDREN, CW_DELETE_WORKSPACE_WITH_RESOURCE, CW_DISC_AND_EMAIL_UNAVAILABLE_EXCEPTION, CW_DISCUSSION_CORRUPTED_EXCEPTION, CW_DISCUSSION_EXCEPTION_NO_ERRCODE, CW_DISCUSSION_INTERNAL_EXCEPTION, CW_DISCUSSION_ITEM_ALREADY_EXIST, CW_DISCUSSION_ITEM_NOT_FOUND, CW_DISCUSSION_ITEM_NOT_FOUND_NOARG, CW_DISCUSSION_UNSUPPORTED_PROPERTY, CW_DISCUSSIONS_EMAIL_GUEST_CANNOT_CREATE_RESOURCE, CW_DUPLICATE_ATTACHMENT, CW_DUPLICATE_WS_TEMPLATE_NAME, CW_DUPLICATED_MEMBER_SUPPLIED, CW_EMAIL_CORRUPTED_EXCEPTION, CW_EMAIL_EXCEPTION_NO_ERRCODE, CW_EMAIL_INTERNAL_EXCEPTION, CW_EMAIL_SESSION_INVALID_WITH_WARNING, CW_EXTERNAL_MEMBER_SUPPLIED, CW_FILES_ACCESS_DENIED, CW_FILES_CANNOT_DELETE_ONLY_VERSION, CW_FILES_CANNOT_LOCK_FOLDERS, CW_FILES_CANNOT_OVERRIDE_FINAL_PARENT, CW_FILES_CORRUPTED_EXCEPTION, CW_FILES_FEATURE_DISABLED, CW_FILES_FILE_IS_NOT_CHECKED_OUT, CW_FILES_HTTP_EXCEPTION, CW_FILES_HTTP_LOCKED_EXCEPTION, CW_FILES_INTERNAL_EXCEPTION, CW_FILES_ITEM_ALREADY_EXIST, CW_FILES_ITEM_ALREADY_LOCKED, CW_FILES_ITEM_NOT_FOUND, CW_FILES_MAX_CONCURRENT_OPS_EXCEEDED, CW_FILES_MEMBER_NOT_FOUND, CW_FILES_OPERATION_NOT_ALLOWED_IN_TRASH, CW_FILES_OVER_QUOTA, CW_FILES_SERVER_CONNECTION_LOST, CW_FILES_SESSION_INVALID_WITH_WARNING, CW_FILES_SHARED_FOLDER_NOT_FOUND, CW_FILES_UNAVAILABLE_EXCEPTION, CW_FILES_UNSUPPORTED_NEW_TRASH_ITEM, CW_FILES_UNSUPPORTED_TRASH_LOCK, CW_FILES_VERSIONING_DISABLED, CW_GET_OCS_USER_ERROR, CW_HTTP_INTERNAL_ERROR, CW_HTTP_UNAUTHORIZED_ERROR, CW_HTTP_UNSUPPORTED_AUTH_SCHEME_ERROR, CW_HTTP_UNSUPPORTED_METHOD_ERROR, CW_IMMUTABLE_UNSUPPORTED_OPERATION, CW_INTERNAL_OP_ERROR, CW_INVALID_CONTENT_SERVICES_ADMINISTRATOR, CW_INVALID_CONTENT_SERVICES_CONTAINER_NAME, CW_INVALID_RECIPIENT_EMAIL_ADDRESS, CW_INVALID_SEARCH_CONTAINER, CW_INVALID_SEARCH_ROOT_ENTITY, CW_INVALID_TEMPLATE_SYNTAX, CW_INVALID_USER_EMAIL, CW_INVALID_WS_METADATA_SEARCH_QUERY, CW_IO_INTERNAL_ERROR, CW_LDAP_ATTRIBUTE_ALREADY_EXIST, CW_LDAP_ATTRIBUTE_ALREADY_EXIST_NOARG, CW_LDAP_ATTRIBUTE_NOT_FOUND, CW_LDAP_ATTRIBUTE_NOT_FOUND_NOARG, CW_LDAP_COMMUNICATION_ERROR, CW_LDAP_CONNECTION_ERROR, CW_LDAP_ENTRY_ALREADY_EXIST, CW_LDAP_ENTRY_ALREADY_EXIST_NOARG, CW_LDAP_ENTRY_NOT_FOUND, CW_LDAP_ENTRY_NOT_FOUND_NOARG, CW_LDAP_EXEC_INTERNAL_ERROR, CW_LDAP_GROUP_ALREADY_EXIST, CW_LDAP_GROUP_NOT_FOUND, CW_LDAP_GROUP_NOT_FOUND_NOARG, CW_LDAP_MEMBER_ALREADY_EXIST, CW_LDAP_MEMBER_NOT_FOUND, CW_LDAP_MEMBER_NOT_FOUND_WSNAME_ONLY, CW_LDAP_MISSING_SEARCHBASE_ERROR, CW_LDAP_MISSING_SUBSCRIBER_ERROR, CW_LDAP_USER_NOT_FOUND, CW_LDAP_USER_NOT_FOUND_NOARG, CW_LDAP_WORKSPACE_ALREADY_EXIST, CW_LDAP_WORKSPACE_NOT_FOUND, CW_LDAP_WORKSPACE_NOT_FOUND_NOARG, CW_MEMBER_ALREADY_EXIST, CW_MEMBER_ALREADY_EXIST_NOARG, CW_MEMBER_MGMT_ATTRIBUTE_ERROR, CW_MEMBER_MGMT_MAX_NUMBER_EXCEEDED, CW_MEMBER_NOT_FOUND, CW_MULTIPLE_VIRTUAL_SERVICE_AVAILABLE, CW_NOT_AUTHORIZED, CW_NOT_AUTHORIZED_WORKSPACE_SETTING, CW_NULL_WORKSPACE_PATH, CW_OPERATION_INSTANCE_NOT_FOUND, CW_OPERATION_INSTANCE_NOT_FOUND_NOARG, CW_PARENT_ENTITY_FOUND, CW_PERMISSION_NAME_INVALID, CW_PRIV_MGMT_SELF, CW_PROPERTIES_NULL, CW_PROPERTY_NOT_FOUND, CW_RESERVED_TEMPLATE_CATEGORY, CW_RESOURCE_ALREADY_EXIST, CW_RESOURCE_ATTR_RSRC_TYPE_MISMATCH, CW_RESOURCE_ATTR_VAL_INVALID, CW_RESOURCE_ATTR_VAL_INVALID_RSRC_TYPE_MOIDIFICATION, CW_RESOURCE_ATTR_VAL_INVALID_UID_MOIDIFICATION, CW_RESOURCE_CONTAINS_ATTACHMENT, CW_RESOURCE_NOT_CONFIGURED, CW_RESOURCE_NOT_FOUND, CW_RESOURCE_NOT_FOUND_NO_WSPC, CW_RESOURCE_NOT_FOUND_NOARG, CW_RESOURCE_NOT_INITIALIZED, CW_RESOURCE_NOT_INSTALLED, CW_RESOURCE_NOT_PROVISION_EXCEPTION_WITH_STATUS, CW_RESOURCE_NOT_PROVISION_EXCEPTION_WITHOUT_STATUS, CW_RESOURCE_STATUS_NOT_SUPPORT_IN_RECOVERY, CW_RESOURCE_STATUS_UNACCESSIBLE, CW_ROLE_NOT_FOUND, CW_RSRC_ITEM_INVALID_DESC, CW_RSRC_ITEM_INVALID_NAME, CW_RSRC_ITEM_INVALID_PERCENT, CW_RSRC_ITEM_INVALID_SECURE_CONTENT_GRANTEE, CW_RSRC_ITEM_INVALID_SECURE_CONTENT_PERMISSION, CW_RSRC_ITEM_PARSING_ERROR, CW_RTC_SESSION_INVALID_WITH_WARNING, CW_SEARCH_INTERNAL_EXCEPTION, CW_SEARCH_INVALID_QUERY, CW_SEARCHLET_CONNECTION_EXCEPTION, CW_SEARCHLET_EXEC_EXCEPTION, CW_SEARCHLET_INIT_EXCEPTION, CW_SEARCHLET_JNDI_EXCEPTION, CW_SEARCHLET_USER_CONTEXT_EXCEPTION, CW_SERVICE_CONFIGURATION_ERROR, CW_SERVICE_UNINIT_ERROR, CW_SERVICE_UNINT_WSPC_MGRS, CW_SESSION_INVALID, CW_SESSION_NULL, CW_SUBGROUP_ALREADY_EXIST, CW_SUBGROUP_NOT_FOUND, CW_SUBGROUP_NOT_FOUND_NOARG, CW_SYSTEM_BUSY_EXCEPTION, CW_TEMPLATE_CONTENT_LOCATION_NOT_FOUND, CW_UID_NOT_IN_WORKSPACE, CW_UNSUPPORTED_SEARCH_ROOT_DESCRIPTOR, CW_UNSUPPORTED_SEARCH_TYPE, CW_VIEW_NOT_FOUND, CW_VIRTUAL_SERVICE_ATTRIBUTE_NOT_FOUND, CW_VIRTUAL_SERVICE_NOT_FOUND, CW_VIRTUAL_SERVICE_TYPE_NOT_FOUND, CW_WEBCONF_INTERNAL_EXCEPTION, CW_WORKSPACE_ALREADY_EXIST, CW_WORKSPACE_ATTR_VAL_INVALID, CW_WORKSPACE_BUSY_EXCEPTION, CW_WORKSPACE_CREATION_PARTIAL_SUCCESS, CW_WORKSPACE_DELETION_PARTIAL_SUCCESS, CW_WORKSPACE_DOES_NOT_NEED_RECOVERY, CW_WORKSPACE_NEED_RECOVERY, CW_WORKSPACE_NEED_RECOVERY_ARG, CW_WORKSPACE_NOT_EMPTY, CW_WORKSPACE_NOT_FOUND, CW_WORKSPACE_NOT_FOUND_NOARG, CW_WORKSPACE_NOT_MATCH, CW_WORKSPACE_ROLE_NAME_INVALID, CW_WORKSPACE_ROLE_NOT_MATCH, CW_WORKSPACE_SHARED_FOLDER_MEMBERSHIP_MISMATCH, CW_WORKSPACE_TEMPLATE_NOT_FOUND, CW_XML_INTERNAL_ERROR, ITEM_CREATED_PROPS_UPDATE_FAILED, OPERATION_SUCCESSFUL_WITH_ERRORS, WORKSPACES

Method Summary

CwBoard	getBoard() Returns the CwBoard which represents the workspace resource "inbox".
long	getBoardId() Returns the ID of the board to which this resource maps.
CwResourceItem	getItemByUid(CwUid uid) Returns the resource item for the given CwUid.
CwResourceBulkResponse	listItemsByUids(CwUid[] uids) Returns an instance of CwResourceBulkResponse which contains all of the successfully-retrieved resource items as well as any that were unable to be retrieved.
void	storeProperties() Set the properties for the resource persistently.

Methods inherited from class oracle.workspaces.resource.CwResource

getProperties, getRecentActivities, getStatus, getUid, getWorkspace

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CW_EMAIL_SUBSCRIPTION_POLICY_NAME

public static final java.lang.String CW_EMAIL_SUBSCRIPTION_POLICY_NAME

See Also:

Constant Field Values

EMAIL_INBOUND_NONE

public static final int EMAIL_INBOUND_NONE

Policy constant prohibiting inbound email to the inbox.

See Also:

Constant Field Values

EMAIL_INBOUND_OPEN

public static final int EMAIL_INBOUND_OPEN

Policy constant allowing inbound email from any user.

See Also:

Constant Field Values

EMAIL_INBOUND_RESTRICTED

public static final int EMAIL_INBOUND_RESTRICTED

Policy constant restricting inbound email to users with write privilege to the inbox.

See Also:

Constant Field Values

SUBSCRIPTION_POLICY_DISABLED

public static final java.lang.String SUBSCRIPTION_POLICY_DISABLED

Policy constant for disabling subscription to the inbox.

See Also:

Constant Field Values

SUBSCRIPTION_POLICY_ENABLED

public static final java.lang.String SUBSCRIPTION_POLICY_ENABLED

Policy constant for enabling subscription to the inbox.

See Also:

Constant Field Values

Method Detail

getBoard

public CwBoard getBoard()
                 throws CwException

Returns the CwBoard which represents the workspace resource "inbox".

Throws:

CwResourceCorruptedException - if the resource-mapped board object cannot be retrieved.

CwException

getBoardId

public long getBoardId()
                throws CwException

Returns the ID of the board to which this resource maps. This is a convenience method which gets the ID from the properties.

Throws:

CwException

getItemByUid

public CwResourceItem getItemByUid(CwUid uid)
                            throws CwException

Returns the resource item for the given CwUid. Note that the CwUid could refer to a thread or message; board lookup is not supported (and in fact is unnecessary since there is only one board in the email resource and you can get it directly). Internally, we need access to the parent object in order to retrieve a child. Therefore, we encode parent ID information into the itemID portion of a Uid for a child object.

Specified by:

getItemByUid in class CwResource

Throws:

CwAttrValException - if the specified uid is badly formatted

CwObjectNotFoundException - if the object is not found.

CwResourceCorruptedException - if the resource-mapped board object cannot be retrieved.

CwException

listItemsByUids

public CwResourceBulkResponse listItemsByUids(CwUid[] uids)
                                       throws CwException

Returns an instance of CwResourceBulkResponse which contains all of the successfully-retrieved resource items as well as any that were unable to be retrieved. Note that this method only supports thread and message uids; there is no need to retrieve board objects this way for the email resource, since there is only one board and it is directly accessible.

Specified by:

listItemsByUids in class CwResource

Parameters:

uids - UIDs of the resource items to be retrieved.

Throws:

CwResourceCorruptedException - if the resource-mapped board object cannot be retrieved.

CwException

storeProperties

public void storeProperties()
                     throws CwException

Set the properties for the resource persistently.

Overrides:

storeProperties in class CwResource

Throws:

CwException