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

  public javax.ws.rs.core.Response getResourceList(java.lang.String responseFormat)
  

  Fetch list of available resources.

  Parameters:

  responseFormat - the response format

  Returns:

  the response

• getAggregatedResourceList

  public javax.ws.rs.core.Response getAggregatedResourceList(java.lang.String responseFormat)
  

  Fetch list of aggregated available resources.

  Parameters:

  responseFormat - the response format

  Returns:

  the response

• getResourceDescription

  public javax.ws.rs.core.Response getResourceDescription(java.lang.String resourceName,
                                                 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

  public javax.ws.rs.core.Response getResourceDescriptionBundle(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.

• createResourceList

  protected org.apache.commons.json.JSONObject createResourceList()
                                                           throws org.apache.commons.json.JSONException
  

  Create a resource list.

  Returns:

  The resource list structure.

  Throws:

  org.apache.commons.json.JSONException - Unexpected.

• 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.

• isLocaleSupportedByStore

  protected boolean isLocaleSupportedByStore(java.lang.String storeId,
                                 java.lang.String localeName)
                                      throws java.lang.Exception
  

  Description copied from class: AbstractBaseResourceHandler
  Test if a locale is supported by a store.

  Overrides:

  isLocaleSupportedByStore in class AbstractBaseResourceHandler

  Parameters:

  storeId - The Store id.

  localeName - The locale name.

  Returns:

  True if the locale is supported.

  Throws:

  java.lang.Exception - Unexpected.

• readIsApiDiscoveryEnabledFromConfiguration

  protected static final boolean readIsApiDiscoveryEnabledFromConfiguration()
  

  Read the "Is authentication allowed using cookies" configuration flag. Using false as a default value.

  Returns:

  the value read from the configuration.