com.vmware.vapi.std

Class StandardDataFactory

java.lang.Object

com.vmware.vapi.std.StandardDataFactory

public class StandardDataFactory
extends java.lang.Object

Factory for DataDefinitions and DataValues for standard vAPI structures, like errors and localizable messages.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALREADY_EXISTS
static java.lang.String	ARGS_FIELD_NAME
static java.lang.String	DATA_FIELD_NAME
static java.lang.String	DEFAUL_MSG_FIELD_NAME
static java.lang.String	ID_FIELD_NAME
static java.lang.String	INTERNAL_SERVER_ERROR
static java.lang.String	INVALID_ARGUMENT
static java.lang.String	MESSAGE_STRUCT_NAME
static java.lang.String	MESSAGES_FIELD_NAME
static java.lang.String	NOT_FOUND
static java.lang.String	OPERATION_NOT_FOUND
static java.util.Map<java.lang.String,com.vmware.vapi.data.DataDefinition>	STANDARD_ERROR_FIELDS
static java.lang.String	UNAUTHENTICATED
static java.lang.String	UNEXPECTED_INPUT

Constructor Summary

Constructors

Constructor and Description
StandardDataFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static ErrorValue	createErrorValueForMessages(com.vmware.vapi.data.ErrorDefinition errorDef, java.util.List<com.vmware.vapi.Message> messages) Creates instance for given error definition and list of Messagess.
static ErrorValue	createErrorValueForMessages(java.lang.String errorName, java.util.List<com.vmware.vapi.Message> messages) Creates a standard error ErrorValue for the given name list of Messagess.
static com.vmware.vapi.data.ErrorDefinition	createStandardErrorDefinition(java.lang.String errorName) Factory method for ErrorDefinitions for standard vAPI errors.
static com.vmware.vapi.data.StructDefinition	getLocalizableMessageDefinition()
static java.util.List<com.vmware.vapi.Message>	getMessagesFromErrorValue(StructValue error) Returns messages associated with the specified standard error ErrorValue represented as list of Messages.

Methods inherited from class java.lang.Object

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

Field Detail

ALREADY_EXISTS

public static final java.lang.String ALREADY_EXISTS

See Also:

Constant Field Values

INTERNAL_SERVER_ERROR

public static final java.lang.String INTERNAL_SERVER_ERROR

See Also:

Constant Field Values

OPERATION_NOT_FOUND

public static final java.lang.String OPERATION_NOT_FOUND

See Also:

Constant Field Values

INVALID_ARGUMENT

public static final java.lang.String INVALID_ARGUMENT

See Also:

Constant Field Values

NOT_FOUND

public static final java.lang.String NOT_FOUND

See Also:

Constant Field Values

UNAUTHENTICATED

public static final java.lang.String UNAUTHENTICATED

See Also:

Constant Field Values

UNEXPECTED_INPUT

public static final java.lang.String UNEXPECTED_INPUT

See Also:

Constant Field Values

MESSAGE_STRUCT_NAME

public static final java.lang.String MESSAGE_STRUCT_NAME

See Also:

Constant Field Values

ID_FIELD_NAME

public static final java.lang.String ID_FIELD_NAME

See Also:

Constant Field Values

DEFAUL_MSG_FIELD_NAME

public static final java.lang.String DEFAUL_MSG_FIELD_NAME

See Also:

Constant Field Values

ARGS_FIELD_NAME

public static final java.lang.String ARGS_FIELD_NAME

See Also:

Constant Field Values

MESSAGES_FIELD_NAME

public static final java.lang.String MESSAGES_FIELD_NAME

See Also:

Constant Field Values

DATA_FIELD_NAME

public static final java.lang.String DATA_FIELD_NAME

See Also:

Constant Field Values

STANDARD_ERROR_FIELDS

public static final java.util.Map<java.lang.String,com.vmware.vapi.data.DataDefinition> STANDARD_ERROR_FIELDS

Constructor Detail

StandardDataFactory

public StandardDataFactory()

Method Detail

getLocalizableMessageDefinition

public static com.vmware.vapi.data.StructDefinition getLocalizableMessageDefinition()

createStandardErrorDefinition

public static com.vmware.vapi.data.ErrorDefinition createStandardErrorDefinition(java.lang.String errorName)

Factory method for ErrorDefinitions for standard vAPI errors.

Creates instance for the specified name. The name is used as name of the StructDefinition represented by the instance. Additionally, a field named "messages" is added to the StructDefinition, the definition of this field is:

    ListDefinition
       StructDefinition
           id  -> StringDefinition
           default_message -> StringDefinition
           args -> ListDefinition
                      StringDefinition
 

That is a list of localizable messages.

Parameters:

errorName - the error name

Returns:

new ErrorDefinition isntance

createErrorValueForMessages

public static ErrorValue createErrorValueForMessages(java.lang.String errorName,
                                     java.util.List<com.vmware.vapi.Message> messages)

Creates a standard error ErrorValue for the given name list of Messagess.

See Also:

createErrorValueForMessages(ErrorDefinition, List)

createErrorValueForMessages

public static ErrorValue createErrorValueForMessages(com.vmware.vapi.data.ErrorDefinition errorDef,
                                     java.util.List<com.vmware.vapi.Message> messages)

Creates instance for given error definition and list of Messagess. The name is used as name of the StructValue represented by the instance. Messages are converted to list of structures and set as "messages" field (of StructValue) of this instance. The structure of the "messages" field is:

    ListValue
       StructValue
           id  -> StringValue
           default_message -> StringValue
           args -> ListValue
                      StringValue
 

Parameters:

errorDef - error definition

messages - the messages for the new ErrorValue

Returns:

new ErrirValue instance

Throws:

java.lang.IllegalArgumentException - if messages or errorDef is null or messages is empty or contains null element(s)

getMessagesFromErrorValue

public static java.util.List<com.vmware.vapi.Message> getMessagesFromErrorValue(StructValue error)

Returns messages associated with the specified standard error ErrorValue represented as list of Messages. This method assumes the structure of "messages" field from createErrorValueForMessages(ErrorDefinition, List). In case this structure is not present - empty list is returned.

Parameters:

error - standard error value

Returns:

list of messages