Package org.codice.ddf.admin.core.api.jmx

Interface AdminConsoleServiceMBean

public interface AdminConsoleServiceMBean
MBean interface for Admin Console back end.

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

  • Field Details

  • Method Details

    • listServices

      List<Service> listServices()
      Lists all managed services and managed service factories with associated metatypes and configurations
      Returns:
      the list of all Services

    • getService

      Service getService(String filter)
      Returns a managed service or managed service factory with associated metatype and configurations

      *@param filter the string representation of the org.osgi.framework.Filter

      Returns:
      Service

    • listModules

      List<Map<String,Object>> listModules()
      Lists all modules that are available
      Returns:
      the list of all Modules

    • createFactoryConfiguration

      String createFactoryConfiguration(String factoryPid) throws IOException
      Create a new configuration instance for the supplied persistent id of the factory, answering the PID of the created configuration
      Parameters:
      factoryPid - the persistent id of the factory
      Returns:
      the PID of the created configuration
      Throws:
      IOException - if the operation failed

    • createFactoryConfigurationForLocation

      String createFactoryConfigurationForLocation(String factoryPid, String location) throws IOException
      Create a factory configuration for the supplied persistent id of the factory and the bundle location bound to bind the created configuration to, answering the PID of the created configuration
      Parameters:
      factoryPid - the persistent id of the factory
      location - the bundle location
      Returns:
      the pid of the created configuation
      Throws:
      IOException - if the operation failed

    • delete

      void delete(String pid) throws IOException
      Delete the configuration
      Parameters:
      pid - the persistent identifier of the configuration
      Throws:
      IOException - if the operation fails

    • deleteForLocation

      void deleteForLocation(String pid, String location) throws IOException
      Delete the configuration
      Parameters:
      pid - the persistent identifier of the configuration
      location - the bundle location
      Throws:
      IOException - if the operation fails

    • deleteConfigurations

      void deleteConfigurations(String filter) throws IOException
      Delete the configurations matching the filter specification.
      Parameters:
      filter - the string representation of the org.osgi.framework.Filter
      Throws:
      IOException - if the operation failed
      IllegalArgumentException - if the filter is invalid

    • getBundleLocation

      String getBundleLocation(String pid) throws IOException
      Answer the bundle location the configuration is bound to
      Parameters:
      pid - the persistent identifier of the configuration
      Returns:
      the bundle location
      Throws:
      IOException - if the operation fails

    • getFactoryPid

      String getFactoryPid(String pid) throws IOException
      Answer the factory PID if the configuration is a factory configuration, null otherwise.
      Parameters:
      pid - the persistent identifier of the configuration
      Returns:
      the factory PID
      Throws:
      IOException - if the operation fails

    • getFactoryPidForLocation

      String getFactoryPidForLocation(String pid, String location) throws IOException
      Answer the factory PID if the configuration is a factory configuration, null otherwise.
      Parameters:
      pid - the persistent identifier of the configuration
      location - the bundle location
      Returns:
      the factory PID
      Throws:
      IOException - if the operation fails

    • getProperties

      Map<String,Object> getProperties(String pid) throws IOException
      Answer the contents of the configuration

      Parameters:
      pid - the persistent identifier of the configuration
      Returns:
      the table of contents
      Throws:
      IOException - if the operation fails
      See Also:
      • for the details of the TabularType

    • getPropertiesForLocation

      Map<String,Object> getPropertiesForLocation(String pid, String location) throws IOException
      Answer the contents of the configuration

      Parameters:
      pid - the persistent identifier of the configuration
      location - the bundle location
      Returns:
      the table of contents
      Throws:
      IOException - if the operation fails
      See Also:
      • for the details of the TabularType

    • getConfigurations

      String[][] getConfigurations(String filter) throws IOException
      Answer the list of PID/Location pairs of the configurations managed by this service
      Parameters:
      filter - the string representation of the org.osgi.framework.Filter
      Returns:
      the list of configuration PID/Location pairs
      Throws:
      IOException - if the operation failed
      IllegalArgumentException - if the filter is invalid

    • setBundleLocation

      void setBundleLocation(String pid, String location) throws IOException
      Set the bundle location the configuration is bound to
      Parameters:
      pid - the persistent identifier of the configuration
      location - the bundle location
      Throws:
      IOException - if the operation fails

    • update

      boolean update(String pid, Map<String,Object> configurationTable) throws IOException
      Update the configuration with the supplied properties For each property entry, the following row is supplied

      It is necessary to have a return value so that the ajax call to Jolokia waits for it to finish and we get any errors returned

      Parameters:
      pid - the persistent identifier of the configuration
      configurationTable - the table of properties
      Throws:
      IOException - if the operation fails
      See Also:
      • for the details of the TabularType

    • updateGuestClaimsProfile

      boolean updateGuestClaimsProfile(String pid, Map<String,Object> configurationTable) throws IOException
      Interceptor method for special handling of guest claims profile data.
      Parameters:
      pid - the persistent identifier of the configuration
      configurationTable - the table of properties
      Throws:
      IOException - if the operation fails update(String, Map).
      See Also:

    • updateForLocation

      void updateForLocation(String pid, String location, Map<String,Object> configurationTable) throws IOException
      Update the configuration with the supplied properties For each property entry, the following row is supplied

      Parameters:
      pid - the persistent identifier of the configuration
      location - the bundle location
      configurationTable - the table of properties
      Throws:
      IOException - if the operation fails
      See Also:
      • for the details of the TabularType

    • enableConfiguration

      ConfigurationStatus enableConfiguration(String servicePid) throws IOException
      Enables a previously disabled configuration
      Parameters:
      servicePid - that uniquely identifies the source to enable.
      Returns:
      the status of the configuration
      Throws:
      IOException - if the Source to be enabled cannot be located via the provided service PID.

    • disableConfiguration

      ConfigurationStatus disableConfiguration(String servicePid) throws IOException
      Disables a configuration but preserves the configuration to be enabled at a later time.
      Parameters:
      servicePid - that uniquely identifies the source to disable.
      Returns:
      the status of the configuration
      Throws:
      IOException - if the Source to be disabled cannot be located via the provided service PID.

    • getClaimsConfiguration

      Map<String,Object> getClaimsConfiguration(String filter)

    • getSsoConfigurations

      Map<String,Object>[] getSsoConfigurations()

    • setSsoConfigurations

      void setSsoConfigurations(Map<String,Object>[] config) throws IOException
      Throws:
      IOException