com.ibm.commerce.rest.infrastructure.handler

Class ConfigurationHandler

java.lang.Object

com.ibm.commerce.foundation.rest.resourcehandler.AbstractBaseResourceHandler

com.ibm.commerce.foundation.rest.resourcehandler.AbstractResourceHandler

com.ibm.commerce.rest.infrastructure.handler.ConfigurationHandler

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

@Path(value="store/{storeId}/configuration")
 @Encoded
public class ConfigurationHandler
extends AbstractResourceHandler

This class provides RESTful services to retrieve Configuration details.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.
static java.lang.String	DEFAULT_ACCESS_PROFILE The default access profile, used when an access profile is not specified using the accessProfile query parameter.
static java.lang.String	FIND_BY_ALL_XPATH The XPATH expression, used to retrieve the Configuration by All
static java.lang.String	FIND_BY_IDENTIFIER_XPATH The XPATH expression, used to retrieve the Configuration by Identifier.
static java.lang.String	RESOURCE_MAPPING_KEY The Constant RESOURCE_MAPPING_KEY.
static java.lang.String	RESOURCE_NAME The Constant RESOURCE_NAME.

Fields inherited from class com.ibm.commerce.foundation.rest.resourcehandler.AbstractBaseResourceHandler

APPLICATION_ATOM_XML, APPLICATION_JSON, APPLICATION_XHTML_XML, APPLICATION_XML, CHANGE_VERB, PARAMETER_ACTION, PARAMETER_ACTION_DESCRIPTION, PARAMETER_CATALOG_ID, PARAMETER_CATALOG_ID_DESCRIPTION, PARAMETER_CURRENCY, PARAMETER_CURRENCY_DESCRIPTION, PARAMETER_FOR_USER, PARAMETER_FOR_USER_DESCRIPTION, PARAMETER_FOR_USER_ID, PARAMETER_FOR_USER_ID_DESCRIPTION, PARAMETER_LANG_ID, PARAMETER_LANG_ID_DESCRIPTION, PARAMETER_LOCALE, PARAMETER_LOCALE_DESCRIPTION, PARAMETER_MODE, PARAMETER_MODE_DESCRIPTION, PARAMETER_PAGE_NUMBER, PARAMETER_PAGE_NUMBER_DESCRIPTION, PARAMETER_PAGE_SIZE, PARAMETER_PAGE_SIZE_DESCRIPTION, PARAMETER_PROFILE_NAME, PARAMETER_PROFILE_NAME_DESCRIPTION, PARAMETER_QUERY, PARAMETER_QUERY_DESCRIPTION, PARAMETER_RESET_PASSWORD_DESCRIPTION, PARAMETER_RESPONSE_FORMAT, PARAMETER_RESPONSE_FORMAT_DESCRIPTION, PARAMETER_STORE_ID, PARAMETER_STORE_ID_DESCRIPTION, PARAMETER_WORKSPACE_IDENTIFIER, PARAMETER_WORKSPACE_IDENTIFIER_DESCRIPTION, PARAMETER_WORKSPACE_NAME, PARAMETER_WORKSPACE_NAME_DESCRIPTION, PARAMETER_WORKSPACE_TASK, PARAMETER_WORKSPACE_TASK_DESCRIPTION, PARAMETER_WORKSPACE_TASKGROUP, PARAMETER_WORKSPACE_TASKGROUP_DESCRIPTION, PROCESS_VERB, RESPONSE_200_DESCRIPTION, RESPONSE_201_DESCRIPTION, RESPONSE_204_DESCRIPTION, RESPONSE_400_DESCRIPTION, RESPONSE_401_DESCRIPTION, RESPONSE_403_DESCRIPTION, RESPONSE_404_DESCRIPTION, RESPONSE_500_DESCRIPTION

Constructor Summary

Constructors

Constructor and Description
ConfigurationHandler()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	all(java.lang.String storeId) This method returns the available configuration identifiers by not specifying any identifier.
javax.ws.rs.core.Response	byConfigurationIds(java.lang.String storeId) This method returns the configuration details by specified configuration identifiers.
javax.ws.rs.core.Response	findByConfigurationId(java.lang.String storeId, java.lang.String configId) This method returns the configuration details by specified configuration identifier.
javax.ws.rs.core.Response	findByQuery(java.lang.String storeId, java.lang.String queryName) Finds page designs by a query.
java.lang.String	getResourceName() This method returns the name of the resource used primarily to determine the representation of the resource.
void	initializeQueryRegistry(OperationRegistry registry) Initializes the registry mapping between the query names and the methods being called to handle requests.

Methods inherited from class com.ibm.commerce.foundation.rest.resourcehandler.AbstractResourceHandler

createMapForProvider, createMapForProvider, generateResponseForEntireDataObject, getMapFromRequest, getStoreId, getUserId, isRequestInPreviewMode, mergeMapsForProvider, prepareAndValidate

Methods inherited from class com.ibm.commerce.foundation.rest.resourcehandler.AbstractBaseResourceHandler

addError, createMapForProviderWithResultData, documentApi, generateResponseFromHttpStatusCodeAndRespData, getActionRegistry, getBooleanParameterValue, getClassDescription, getDoubleParameterValue, getDoubleParameterValues, getEnumeratedParameterValue, getErrorCodeFromMessage, getExternalResourceName, getFormattedMessage, getFormattedMessageWithLocale, getFormattingGroupName, getInstrumentor, getIntegerParameterValue, getIntegerParameterValues, getLongParameterValue, getLongParameterValues, getParameterValue, getParameterValue, getParameterValues, getQueryRegistry, getRequest, getResponse, getUriInfo, handleException, initializeActionRegistry, performAction, postProcess, preProcess, registerOperationWithMethodSignature, runQuery, staticConvertStreamToString, throwInvalidQueryNameException, throwInvalidQueryNameException, throwRestException, throwRestExceptionIfErrorsAreDetected, validatePageNumberPageSize

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

DEFAULT_ACCESS_PROFILE

public static final java.lang.String DEFAULT_ACCESS_PROFILE

The default access profile, used when an access profile is not specified using the accessProfile query parameter.

See Also:

Constant Field Values

RESOURCE_NAME

public static final java.lang.String RESOURCE_NAME

The Constant RESOURCE_NAME.

See Also:

Constant Field Values

RESOURCE_MAPPING_KEY

public static final java.lang.String RESOURCE_MAPPING_KEY

The Constant RESOURCE_MAPPING_KEY.

See Also:

Constant Field Values

FIND_BY_ALL_XPATH

public static final java.lang.String FIND_BY_ALL_XPATH

The XPATH expression, used to retrieve the Configuration by All

See Also:

Constant Field Values

FIND_BY_IDENTIFIER_XPATH

public static final java.lang.String FIND_BY_IDENTIFIER_XPATH

The XPATH expression, used to retrieve the Configuration by Identifier.

See Also:

Constant Field Values

Constructor Detail

ConfigurationHandler

public ConfigurationHandler()

Method Detail

getResourceName

public java.lang.String getResourceName()

Description copied from interface: IResourceHandler

This method returns the name of the resource used primarily to determine the representation of the resource. This class can be overridden to change the name of the resource and therefore the representation, while keeping all the methods in this class.

Returns:

the resource name

See Also:

IResourceHandler.getResourceName()

initializeQueryRegistry

public void initializeQueryRegistry(OperationRegistry registry)

Initializes the registry mapping between the query names and the methods being called to handle requests.

Overrides:

initializeQueryRegistry in class AbstractBaseResourceHandler

Parameters:

registry - The operation registry object.

findByConfigurationId

@GET
 @Path(value="{configurationId}")
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
public javax.ws.rs.core.Response findByConfigurationId(@PathParam(value="storeId")
                                                                                                                                                                                                      java.lang.String storeId,
                                                                                                                                                                                                      @PathParam(value="configurationId")
                                                                                                                                                                                                      java.lang.String configId)

This method returns the configuration details by specified configuration identifier.

Parameters:

storeId - The store identifier.

configId - The configuration identifier.

Returns:

The array of configuration details in the specified format.

all

public javax.ws.rs.core.Response all(@PathParam(value="storeId")
                                     java.lang.String storeId)

This method returns the available configuration identifiers by not specifying any identifier.

Parameters:

storeId - The store identifier.

Returns:

The array of configuration details in the specified format.

byConfigurationIds

public javax.ws.rs.core.Response byConfigurationIds(@PathParam(value="storeId")
                                                    java.lang.String storeId)
                                             throws com.ibm.commerce.foundation.rest.resourcehandler.RestException

This method returns the configuration details by specified configuration identifiers.

Parameters:

storeId - The store identifier.

Returns:

The array of configuration details in the specified format.

Throws:

com.ibm.commerce.foundation.rest.resourcehandler.RestException - is raised when the or is missing.

findByQuery

@GET
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
public javax.ws.rs.core.Response findByQuery(@PathParam(value="storeId")
                                                                                                                                                          java.lang.String storeId,
                                                                                                                                                          @QueryParam(value="q")
                                                                                                                                                          java.lang.String queryName)

Finds page designs by a query. See each query for details on input and output.

Parameters:

storeId - The store ID.

queryName - The query name.

Returns:

The response.