org.wso2.carbon.mediation.initializer.persistence

## Class APIStore

- java.lang.Object
- - org.wso2.carbon.mediation.initializer.persistence.AbstractStore<org.apache.synapse.rest.API>
  - - org.wso2.carbon.mediation.initializer.persistence.APIStore

-     public class APIStore
      extends AbstractStore<org.apache.synapse.rest.API>

- - ### Field Summary

    - ### Fields inherited from class org.wso2.carbon.mediation.initializer.persistence.AbstractStore

      `configPath, log, registryStore, serializer`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `APIStore(String configPath, org.wso2.carbon.registry.core.session.UserRegistry registry, String configName)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | `deleteFile(String fileName, org.apache.synapse.config.SynapseConfiguration synapseConfiguration)` Delete the specified file from the persistence store.
    `protected String` | `getFileName(org.apache.synapse.rest.API api)` Inspect the given object and find the file name to which it should be serialized to
    `protected org.apache.synapse.rest.API` | `getObjectToPersist(String name, org.apache.synapse.config.SynapseConfiguration config)` Find the specified object from the SynaspeConfiguration to be saved to the persistence store
    `protected org.apache.axiom.om.OMElement` | `saveToFile(org.apache.synapse.rest.API api, org.apache.synapse.config.SynapseConfiguration synapseConfig)` Serialize and save the given object to the local file system
    `protected org.apache.axiom.om.OMElement` | `serialize(org.apache.synapse.rest.API api)` Serialize the given object into XML

    - ### Methods inherited from class org.wso2.carbon.mediation.initializer.persistence.AbstractStore

      `delete, deleteFromRegistry, deleteItemFromRegistry, handleException, save, saveItemToRegistry, saveToRegistry`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### APIStore

          public APIStore(String configPath,
                          org.wso2.carbon.registry.core.session.UserRegistry registry,
                          String configName)

  - ### Method Detail

    - #### getFileName

          protected String getFileName(org.apache.synapse.rest.API api)

      Description copied from class: `AbstractStore`
      Inspect the given object and find the file name to which it should be serialized to
      Specified by:
        `getFileName` in class `AbstractStore<org.apache.synapse.rest.API>`
      Parameters:
        `api` - The object to be inspected
      Returns:
        A file name as a string or null if no file name is specified

    - #### getObjectToPersist

          protected org.apache.synapse.rest.API getObjectToPersist(String name,
                                                                   org.apache.synapse.config.SynapseConfiguration config)

      Description copied from class: `AbstractStore`
      Find the specified object from the SynaspeConfiguration to be saved to the persistence store
      Specified by:
        `getObjectToPersist` in class `AbstractStore<org.apache.synapse.rest.API>`
      Parameters:
        `name` - Name or unique ID of the object
        `config` - Current SynapseConfiguration
      Returns:
        The named object or null if such an object doesn't exist

    - #### saveToFile

          protected org.apache.axiom.om.OMElement saveToFile(org.apache.synapse.rest.API api,
                                                             org.apache.synapse.config.SynapseConfiguration synapseConfig)

      Description copied from class: `AbstractStore`
      Serialize and save the given object to the local file system
      Specified by:
        `saveToFile` in class `AbstractStore<org.apache.synapse.rest.API>`
      Parameters:
        `api` - Object to be saved
        `synapseConfig` - synapse configuration
      Returns:
        The OMElement generated as a result of the serialization or null

    - #### serialize

          protected org.apache.axiom.om.OMElement serialize(org.apache.synapse.rest.API api)

      Description copied from class: `AbstractStore`
      Serialize the given object into XML
      Specified by:
        `serialize` in class `AbstractStore<org.apache.synapse.rest.API>`
      Parameters:
        `api` - The object to be serialized
      Returns:
        The resulting OMElement

    - #### deleteFile

          protected void deleteFile(String fileName,
                                    org.apache.synapse.config.SynapseConfiguration synapseConfiguration)

      Description copied from class: `AbstractStore`
      Delete the specified file from the persistence store. File name is provided as an argument and it is up to the implementation to the calculate the exact file path using the file name and other available data.
      Specified by:
        `deleteFile` in class `AbstractStore<org.apache.synapse.rest.API>`
      Parameters:
        `fileName` - Name of the file to be deleted
        `synapseConfiguration` - synapse configuration

Copyright © 2020 WSO2. All rights reserved.