org.wso2.carbon.registry.synchronization.message
Enum MessageCode

java.lang.Object
  extended by java.lang.Enum<MessageCode>
      extended by org.wso2.carbon.registry.synchronization.message.MessageCode
All Implemented Interfaces:
Serializable, Comparable<MessageCode>

public enum MessageCode
extends Enum<MessageCode>

An enumeration of various codes used by the messages involved in various operations of the API, and some others designed for the use of 3rd parties using the API. This includes message codes for informative messages, error messages, and messages requesting a confirmation from a user before performing an operation.


Enum Constant Summary
ADDED
          The file or directory has been added.
ADDED_SUCCESS
          A successful addition.
CHECK_IN_META_INFO_NOT_FOUND
          Meta information related to check-in not found.
CHECK_IN_OPERATION_ABORTED
          The check-in operation has been aborted.
CHECK_IN_RESOURCES_CONFIRMATION
          Confirmation to check-in resources.
CHECKOUT_BEFORE_CHECK_IN
          A check-out must be done before check-in.
CHECKOUT_BEFORE_UPDATE
          A check-out must exist before trying to execute an update operation.
CHECKOUT_OLD_VERSION
          The given carbon version is not supported by the synchronization API.
CO_PATH_MISSING
          The path from which the check-out must be done is missing.
COLLECTION_AND_RESOURCE_SAME_NAME
          A collection and a resource by the same name.
CONFLICTED
          The file or directory is in a conflicted state.
CONFLICTED_FAILURE
          A failure due to conflict.
CURRENT_COLLECTION_NOT_UNDER_REGISTRY_CONTROL
          Current path of the collection of adding resource/collection which is not in the registry
DELETED
          The file or directory has been deleted.
DELETED_SUCCESS
          A successful deletion.
DIRECTORY_DELETE_CONFIRMATION
          Confirmation to delete a directory.
DUMP_FILE_MISSING
          Missing dump file.
DUMPING_NON_COLLECTION
          The dump request was made to a resource instead of a collection.
ERROR_CREATING_META_FILE
          An error occurred while creating meta file.
ERROR_DECODING_PATH
          An error occurred while decoding path.
ERROR_DUMP_PATH_RESOURCE_NOT_EXIST
          An error occurred while dumping due to resource not existing on the registry.
ERROR_ENCODING_RESOURCE_NAME
          An error occurred while encoding resource name.
ERROR_IN_ADDING_METADATA
          An error occurred while adding the new RESOURCE/COLLECTION
ERROR_IN_CLEANING_UP
          An error occurred while cleaning up temporary file or directory.
ERROR_IN_CLOSING_META_FILE_STREAM
          An error occurred while closing meta file stream.
ERROR_IN_CLOSING_STREAM
          An error occurred while closing the stream.
ERROR_IN_COMPLETELY_READING
          An error occurred due to being unable to read whole file.
ERROR_IN_CONNECTING_REGISTRY
          An error occurred while connecting to the registry.
ERROR_IN_COPYING
          An error occurred while copying content.
ERROR_IN_CREATING_TEMP_FILE_FOR_DUMP
          An error occurred while creating temporary file for dump.
ERROR_IN_CREATING_XML_STREAM_WRITER
          An error occurred while creating XML stream writer.
ERROR_IN_DELETING
          An error occurred while deleting file or directory.
ERROR_IN_DUMPING
          An error occurred while dumping the path.
ERROR_IN_DUMPING_AUTHORIZATION_FAILED
          An error occurred while dumping due to the user not having sufficient permissions.
ERROR_IN_DUMPING_NO_RESOURCE_OR_NO_PERMISSION
          An error occurred while dumping due to resource not found or user not having sufficient permissions.
ERROR_IN_READING
          An error occurred while reading the file.
ERROR_IN_READING_META_FILE
          An error occurred while reading meta file.
ERROR_IN_READING_META_FILE_STREAM
          An error occurred while reading meta file stream.
ERROR_IN_READING_STREAM_OF_TEMP_FILE_OF_DUMP
          An error occurred while reading the stream of the temporary file for dump.
ERROR_IN_READING_STREAM_TO_CREATE_META_FILE
          An error occurred while reading stream that is used to create meta file.
ERROR_IN_READING_TEMP_FILE_OF_DUMP
          An error occurred while reading temporary file for dump.
ERROR_IN_RESTORING
          An error occurred during restoration.
ERROR_WRITING_TO_META_FILE
          An error occurred while writing to the meta file.
FILE_ALREADY_EXISTS
          A file already exists at the given location.
FILE_CREATION_FAILED
          The creation of the file failed.
FILE_DELETE_CONFIRMATION
          Confirmation to delete a file.
FILE_DOES_NOT_EXIST
          The file does not exist.
FILE_LENGTH_IS_TOO_LARGE
          The length of the file is too large.
FILE_OVERWRITE_CONFIRMATION
          Confirmation to overwrite a file.
FILE_TO_READ_IS_NOT_FOUND
          The file to be read is not found.
HELP
          Generic help on using a client.
INVALID_DUMP_CREATE_META_FILE
          Invalid dump to create a meta file.
KEEP_DELETED_FILE
          Keep the local deleted file in an update
MALFORMED_URL
          Malformed URL.
NO_FILES_ADDED
          No files have been added.
NO_FILES_CONFLICTED
          No files are in conflict.
NO_FILES_DELETED
          No files have been deleted.
NO_FILES_UPDATED
          No files have been updated.
NO_OPTIONS_PROVIDED
          No options provided.
NON_OVERWRITTEN
          The file or directory has not been overwritten.
NON_OVERWRITTEN_FINAL
          Total number of files not overwritten.
NOT_DELETED
          The file or directory has not been deleted.
NOT_DELETED_FINAL
          Total number of files that were not deleted.
OPERATION_NOT_FOUND
          Incorrect operation.
OUTPUT_FILE_NOT_SUPPORTED
          Output to a file is not supported for the given operation.
OVERWRITTEN
          The file or directory has been overwritten.
OVERWRITTEN_FINAL
          Total number of files overwritten.
PASSWORD_MISSING
          Missing password value in argument.
PROBLEM_IN_CREATING_CONTENT
          Unable to write content to the file.
REALM_SERVICE_FAILED
          Error in initializing the realm service.
REGISTRY_SERVICE_FAILED
          Error in obtaining the registry OSGi service.
REGISTRY_TYPE_MISSING
          Missing registry type.
RESOLVE_CONFLICTS
          Resolve conflicts before executing operation.
RESOURCE_ALREADY_UNDER_REGISTRY_CONTROL
          Adding resource/collection which is already in the registry
RESOURCE_METADATA_CORRUPTED
          Resource metadata corrupted
RESOURCE_NOT_UNDER_REGISTRY_CONTROL
           
RESTORE_URL_NOT_PROVIDED
          The restoration URL has not been provided.
SENT
          The file or directory has been sent.
SUCCESS
          Operation successfully completed.
TRANSMIT_SUCCESS
          A successful transmission.
UNSUPPORTED_DUMP_FORMAT
          The dump format is not supported.
UPDATE_FROM_DIFFERENT_LOCATION
          Unable to update from a location different to the initial check-out.
UPDATE_META_INFO_NOT_FOUND
          Meta information related to update not found.
UPDATED
          The file or directory has been updated.
UPDATED_SUCCESS
          A successful update.
USER_REGISTRY_FAILED
          Error in obtaining an instance of a user registry.
USERNAME_MISSING
          Missing username value in argument.
USERNAME_NOT_PROVIDED
          The required field username has not been provided.
WORKING_DIR_MISSING
          Missing working directory.
WRONG_WORKING_DIR
          Wrong working directory.
 
Method Summary
static MessageCode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static MessageCode[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ADDED

public static final MessageCode ADDED
The file or directory has been added.


SENT

public static final MessageCode SENT
The file or directory has been sent.


DELETED

public static final MessageCode DELETED
The file or directory has been deleted.


NOT_DELETED

public static final MessageCode NOT_DELETED
The file or directory has not been deleted.


CONFLICTED

public static final MessageCode CONFLICTED
The file or directory is in a conflicted state.


UPDATED

public static final MessageCode UPDATED
The file or directory has been updated.


OVERWRITTEN

public static final MessageCode OVERWRITTEN
The file or directory has been overwritten.


NON_OVERWRITTEN

public static final MessageCode NON_OVERWRITTEN
The file or directory has not been overwritten.


HELP

public static final MessageCode HELP
Generic help on using a client.


SUCCESS

public static final MessageCode SUCCESS
Operation successfully completed.


CHECK_IN_OPERATION_ABORTED

public static final MessageCode CHECK_IN_OPERATION_ABORTED
The check-in operation has been aborted.


TRANSMIT_SUCCESS

public static final MessageCode TRANSMIT_SUCCESS
A successful transmission.


ADDED_SUCCESS

public static final MessageCode ADDED_SUCCESS
A successful addition.


UPDATED_SUCCESS

public static final MessageCode UPDATED_SUCCESS
A successful update.


CONFLICTED_FAILURE

public static final MessageCode CONFLICTED_FAILURE
A failure due to conflict.


DELETED_SUCCESS

public static final MessageCode DELETED_SUCCESS
A successful deletion.


OVERWRITTEN_FINAL

public static final MessageCode OVERWRITTEN_FINAL
Total number of files overwritten.


NON_OVERWRITTEN_FINAL

public static final MessageCode NON_OVERWRITTEN_FINAL
Total number of files not overwritten.


NO_FILES_ADDED

public static final MessageCode NO_FILES_ADDED
No files have been added.


NOT_DELETED_FINAL

public static final MessageCode NOT_DELETED_FINAL
Total number of files that were not deleted.


NO_FILES_UPDATED

public static final MessageCode NO_FILES_UPDATED
No files have been updated.


NO_FILES_CONFLICTED

public static final MessageCode NO_FILES_CONFLICTED
No files are in conflict.


NO_FILES_DELETED

public static final MessageCode NO_FILES_DELETED
No files have been deleted.


CO_PATH_MISSING

public static final MessageCode CO_PATH_MISSING
The path from which the check-out must be done is missing.


RESOLVE_CONFLICTS

public static final MessageCode RESOLVE_CONFLICTS
Resolve conflicts before executing operation.


DUMPING_NON_COLLECTION

public static final MessageCode DUMPING_NON_COLLECTION
The dump request was made to a resource instead of a collection.


FILE_CREATION_FAILED

public static final MessageCode FILE_CREATION_FAILED
The creation of the file failed.


PROBLEM_IN_CREATING_CONTENT

public static final MessageCode PROBLEM_IN_CREATING_CONTENT
Unable to write content to the file.


OUTPUT_FILE_NOT_SUPPORTED

public static final MessageCode OUTPUT_FILE_NOT_SUPPORTED
Output to a file is not supported for the given operation.


CHECKOUT_BEFORE_UPDATE

public static final MessageCode CHECKOUT_BEFORE_UPDATE
A check-out must exist before trying to execute an update operation.


COLLECTION_AND_RESOURCE_SAME_NAME

public static final MessageCode COLLECTION_AND_RESOURCE_SAME_NAME
A collection and a resource by the same name. This happens when we try to execute an update, and when we attempt to replace a file with a collection or directory with a resource.


FILE_TO_READ_IS_NOT_FOUND

public static final MessageCode FILE_TO_READ_IS_NOT_FOUND
The file to be read is not found.


FILE_LENGTH_IS_TOO_LARGE

public static final MessageCode FILE_LENGTH_IS_TOO_LARGE
The length of the file is too large.


UNSUPPORTED_DUMP_FORMAT

public static final MessageCode UNSUPPORTED_DUMP_FORMAT
The dump format is not supported.


CHECKOUT_OLD_VERSION

public static final MessageCode CHECKOUT_OLD_VERSION
The given carbon version is not supported by the synchronization API.


INVALID_DUMP_CREATE_META_FILE

public static final MessageCode INVALID_DUMP_CREATE_META_FILE
Invalid dump to create a meta file.


CHECKOUT_BEFORE_CHECK_IN

public static final MessageCode CHECKOUT_BEFORE_CHECK_IN
A check-out must be done before check-in.


ERROR_IN_RESTORING

public static final MessageCode ERROR_IN_RESTORING
An error occurred during restoration.


ERROR_IN_DUMPING_NO_RESOURCE_OR_NO_PERMISSION

public static final MessageCode ERROR_IN_DUMPING_NO_RESOURCE_OR_NO_PERMISSION
An error occurred while dumping due to resource not found or user not having sufficient permissions.


ERROR_IN_DUMPING_AUTHORIZATION_FAILED

public static final MessageCode ERROR_IN_DUMPING_AUTHORIZATION_FAILED
An error occurred while dumping due to the user not having sufficient permissions.


ERROR_IN_DUMPING

public static final MessageCode ERROR_IN_DUMPING
An error occurred while dumping the path.


ERROR_CREATING_META_FILE

public static final MessageCode ERROR_CREATING_META_FILE
An error occurred while creating meta file.


ERROR_WRITING_TO_META_FILE

public static final MessageCode ERROR_WRITING_TO_META_FILE
An error occurred while writing to the meta file.


ERROR_IN_READING

public static final MessageCode ERROR_IN_READING
An error occurred while reading the file.


ERROR_IN_COMPLETELY_READING

public static final MessageCode ERROR_IN_COMPLETELY_READING
An error occurred due to being unable to read whole file.


ERROR_IN_READING_META_FILE

public static final MessageCode ERROR_IN_READING_META_FILE
An error occurred while reading meta file.


ERROR_IN_READING_META_FILE_STREAM

public static final MessageCode ERROR_IN_READING_META_FILE_STREAM
An error occurred while reading meta file stream.


ERROR_IN_CLOSING_META_FILE_STREAM

public static final MessageCode ERROR_IN_CLOSING_META_FILE_STREAM
An error occurred while closing meta file stream.


ERROR_IN_COPYING

public static final MessageCode ERROR_IN_COPYING
An error occurred while copying content.


ERROR_ENCODING_RESOURCE_NAME

public static final MessageCode ERROR_ENCODING_RESOURCE_NAME
An error occurred while encoding resource name.


ERROR_DECODING_PATH

public static final MessageCode ERROR_DECODING_PATH
An error occurred while decoding path.


ERROR_IN_DELETING

public static final MessageCode ERROR_IN_DELETING
An error occurred while deleting file or directory.


ERROR_IN_CLEANING_UP

public static final MessageCode ERROR_IN_CLEANING_UP
An error occurred while cleaning up temporary file or directory.


ERROR_IN_CREATING_TEMP_FILE_FOR_DUMP

public static final MessageCode ERROR_IN_CREATING_TEMP_FILE_FOR_DUMP
An error occurred while creating temporary file for dump.


ERROR_IN_READING_TEMP_FILE_OF_DUMP

public static final MessageCode ERROR_IN_READING_TEMP_FILE_OF_DUMP
An error occurred while reading temporary file for dump.


ERROR_IN_READING_STREAM_OF_TEMP_FILE_OF_DUMP

public static final MessageCode ERROR_IN_READING_STREAM_OF_TEMP_FILE_OF_DUMP
An error occurred while reading the stream of the temporary file for dump.


ERROR_IN_READING_STREAM_TO_CREATE_META_FILE

public static final MessageCode ERROR_IN_READING_STREAM_TO_CREATE_META_FILE
An error occurred while reading stream that is used to create meta file.


ERROR_IN_CREATING_XML_STREAM_WRITER

public static final MessageCode ERROR_IN_CREATING_XML_STREAM_WRITER
An error occurred while creating XML stream writer.


ERROR_DUMP_PATH_RESOURCE_NOT_EXIST

public static final MessageCode ERROR_DUMP_PATH_RESOURCE_NOT_EXIST
An error occurred while dumping due to resource not existing on the registry.


ERROR_IN_CONNECTING_REGISTRY

public static final MessageCode ERROR_IN_CONNECTING_REGISTRY
An error occurred while connecting to the registry.


ERROR_IN_ADDING_METADATA

public static final MessageCode ERROR_IN_ADDING_METADATA
An error occurred while adding the new RESOURCE/COLLECTION


NO_OPTIONS_PROVIDED

public static final MessageCode NO_OPTIONS_PROVIDED
No options provided.


USERNAME_MISSING

public static final MessageCode USERNAME_MISSING
Missing username value in argument.


PASSWORD_MISSING

public static final MessageCode PASSWORD_MISSING
Missing password value in argument.


REGISTRY_TYPE_MISSING

public static final MessageCode REGISTRY_TYPE_MISSING
Missing registry type.


WORKING_DIR_MISSING

public static final MessageCode WORKING_DIR_MISSING
Missing working directory.


WRONG_WORKING_DIR

public static final MessageCode WRONG_WORKING_DIR
Wrong working directory.


DUMP_FILE_MISSING

public static final MessageCode DUMP_FILE_MISSING
Missing dump file.


OPERATION_NOT_FOUND

public static final MessageCode OPERATION_NOT_FOUND
Incorrect operation.


USERNAME_NOT_PROVIDED

public static final MessageCode USERNAME_NOT_PROVIDED
The required field username has not been provided.


RESTORE_URL_NOT_PROVIDED

public static final MessageCode RESTORE_URL_NOT_PROVIDED
The restoration URL has not been provided.


FILE_DOES_NOT_EXIST

public static final MessageCode FILE_DOES_NOT_EXIST
The file does not exist.


CHECK_IN_META_INFO_NOT_FOUND

public static final MessageCode CHECK_IN_META_INFO_NOT_FOUND
Meta information related to check-in not found.


FILE_ALREADY_EXISTS

public static final MessageCode FILE_ALREADY_EXISTS
A file already exists at the given location.


UPDATE_META_INFO_NOT_FOUND

public static final MessageCode UPDATE_META_INFO_NOT_FOUND
Meta information related to update not found.


UPDATE_FROM_DIFFERENT_LOCATION

public static final MessageCode UPDATE_FROM_DIFFERENT_LOCATION
Unable to update from a location different to the initial check-out.


MALFORMED_URL

public static final MessageCode MALFORMED_URL
Malformed URL.


ERROR_IN_CLOSING_STREAM

public static final MessageCode ERROR_IN_CLOSING_STREAM
An error occurred while closing the stream.


REALM_SERVICE_FAILED

public static final MessageCode REALM_SERVICE_FAILED
Error in initializing the realm service.


REGISTRY_SERVICE_FAILED

public static final MessageCode REGISTRY_SERVICE_FAILED
Error in obtaining the registry OSGi service.


USER_REGISTRY_FAILED

public static final MessageCode USER_REGISTRY_FAILED
Error in obtaining an instance of a user registry.


DIRECTORY_DELETE_CONFIRMATION

public static final MessageCode DIRECTORY_DELETE_CONFIRMATION
Confirmation to delete a directory.


FILE_DELETE_CONFIRMATION

public static final MessageCode FILE_DELETE_CONFIRMATION
Confirmation to delete a file.


FILE_OVERWRITE_CONFIRMATION

public static final MessageCode FILE_OVERWRITE_CONFIRMATION
Confirmation to overwrite a file.


CHECK_IN_RESOURCES_CONFIRMATION

public static final MessageCode CHECK_IN_RESOURCES_CONFIRMATION
Confirmation to check-in resources.


KEEP_DELETED_FILE

public static final MessageCode KEEP_DELETED_FILE
Keep the local deleted file in an update


RESOURCE_ALREADY_UNDER_REGISTRY_CONTROL

public static final MessageCode RESOURCE_ALREADY_UNDER_REGISTRY_CONTROL
Adding resource/collection which is already in the registry


CURRENT_COLLECTION_NOT_UNDER_REGISTRY_CONTROL

public static final MessageCode CURRENT_COLLECTION_NOT_UNDER_REGISTRY_CONTROL
Current path of the collection of adding resource/collection which is not in the registry


RESOURCE_METADATA_CORRUPTED

public static final MessageCode RESOURCE_METADATA_CORRUPTED
Resource metadata corrupted


RESOURCE_NOT_UNDER_REGISTRY_CONTROL

public static final MessageCode RESOURCE_NOT_UNDER_REGISTRY_CONTROL
Method Detail

values

public static MessageCode[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (MessageCode c : MessageCode.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static MessageCode valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null


Copyright © 2013 WSO2 Inc. All Rights Reserved.