com.ibm.commerce.rest.api.handler

Class ApiHandler

java.lang.Object

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

com.ibm.commerce.rest.api.handler.ApiHandler

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

@Path(value="api")
public class ApiHandler
extends AbstractBaseResourceHandler

Exposes the API metadata that describes the list of available resources, operations and data schemas.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.
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
ApiHandler()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getAggregatedResourceList(java.lang.String responseFormat) Fetch list of aggregated available resources.
javax.ws.rs.core.Response	getResourceDescription(java.lang.String resourceName, java.lang.String responseFormat) Describe the APIs available on a resource by name.
javax.ws.rs.core.Response	getResourceDescriptionBundle(java.lang.String resourceName) Generate the default resource bundle for a resource.
static java.util.Map<java.lang.String,java.lang.Class>	getResourceHandlerMap()
javax.ws.rs.core.Response	getResourceList(java.lang.String responseFormat) Fetch list of available resources.
java.lang.String	getResourceName() This method returns the name of the resource used primarily to determine the representation of the resource.
boolean	isDiscoveryEnabled() Is API Discovery enabled.
boolean	isRequestInPreviewMode() Test if the request is executed in preview mode.
static void	populateResourceHandlerMap(java.lang.String baseConfigLoc) Populate the resource handler map for a specific servlet context.

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, initializeQueryRegistry, 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

RESOURCE_NAME

public static final java.lang.String RESOURCE_NAME

The Constant RESOURCE_NAME.

See Also:

Constant Field Values

Constructor Detail

ApiHandler

public ApiHandler()

Method Detail

getResourceHandlerMap

public static java.util.Map<java.lang.String,java.lang.Class> getResourceHandlerMap()

Returns:

The map of resource handlers by name.

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.

getResourceList

@GET
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getResourceList(@QueryParam(value="responseFormat")
                                                                                                               java.lang.String responseFormat)

Fetch list of available resources.

Parameters:

responseFormat - the response format

Returns:

the response

getAggregatedResourceList

@GET
 @Path(value="aggregated")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getAggregatedResourceList(@QueryParam(value="responseFormat")
                                                                                                                                                    java.lang.String responseFormat)

Fetch list of aggregated available resources.

Parameters:

responseFormat - the response format

Returns:

the response

getResourceDescription

@GET
 @Path(value="resource/{resourceName}")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getResourceDescription(@PathParam(value="resourceName")
                                                                                                                                                              java.lang.String resourceName,
                                                                                                                                                              @QueryParam(value="responseFormat")
                                                                                                                                                              java.lang.String responseFormat)

Describe the APIs available on a resource by name.

Parameters:

resourceName - Name of the resource.

responseFormat - the response format

Returns:

the response

getResourceDescriptionBundle

@GET
 @Path(value="bundle/{resourceName}")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getResourceDescriptionBundle(@PathParam(value="resourceName")
                                                                                                                                                                  java.lang.String resourceName)

Generate the default resource bundle for a resource.

Parameters:

resourceName - Name of the resource.

Returns:

the response

isDiscoveryEnabled

public boolean isDiscoveryEnabled()

Is API Discovery enabled.

Returns:

true if discovery is enabled.

populateResourceHandlerMap

public static void populateResourceHandlerMap(java.lang.String baseConfigLoc)

Populate the resource handler map for a specific servlet context.

Parameters:

String - The base configuration location.

isRequestInPreviewMode

public boolean isRequestInPreviewMode()

Description copied from class: AbstractBaseResourceHandler

Test if the request is executed in preview mode.

Specified by:

isRequestInPreviewMode in class AbstractBaseResourceHandler

Returns:

True or false.