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

  public javax.ws.rs.core.Response findByConfigurationId(java.lang.String storeId,
                                                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(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(java.lang.String storeId)
                                               throws 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:

  RestException - is raised when the or is missing.

• findByQuery

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

• renderGetConfiguration

  protected javax.ws.rs.core.Response renderGetConfiguration(java.lang.String template,
                                                 java.lang.String accessProfile,
                                                 java.lang.String responseFormat,
                                                 java.lang.Object... values)
  

  This method builds the response in appropriate format.

  Parameters:

  template - The expression template used to retrieve the configuration.

  accessProfile - The access profile to be used.

  responseFormat - The response format.

  values - The object or object array with values to fill the expression template.

  Returns:

  the response for configuration.