All Known Implementing Classes:
LinuxService, ServiceAdapter, WindowsService

public interface Service
Represents an abstract Service. This interface defines sufficient methods for any platform integration of application server with various service control mechanisms on various platforms.
Since:
SJSAS 9.1
Author:
Kedar Mhaswade
See Also:
  • invalid reference
    #isConfigValid
  • Method Details

    • getServerDirs

      com.sun.enterprise.util.io.ServerDirs getServerDirs()
      get the dirs with this thread-safe immutable guaranteed object. It saves a LOT of error checking... You should set the variable in the constructor. You are not allowed to change it later
      Parameters:
      dirs -
    • getServiceProperties

      String getServiceProperties()
      Returns the additional properties of the Service.
      Returns:
      String representing addtional properties of the service. May return default properties as well.
    • setServiceProperties

      void setServiceProperties(String cds)
      Sets the additional service properties that are specific to it.
      Parameters:
      must - be a colon separated String, if not null. No effect, if null is passed.
    • tokensAndValues

      Map<String,String> tokensAndValues()
      Returns the tokens and values of the service as a map. This method converts a service into corresponding tokens and their values.
      Returns:
      tokens and values as a Mapinvalid input: '<'String, String>.
    • createService

      void createService()
      Creates an arbitrary service, specified by certain parameters. The implementations should dictate the mappings in the parameters received. The creation of service is either successful or not. In other words, the implementations must retain the original state of the operating platform if the service creation is not successful completely.
      Parameters:
      params - a Map between Strings that represents the name value pairs required to create the service
      Throws:
      RuntimeException - if there is any error is creation of service
    • getSuccessMessage

      String getSuccessMessage()
    • writeReadmeFile

      void writeReadmeFile(String msg)
    • getLocationArgsStart

      String getLocationArgsStart()
    • getLocationArgsRestart

      String getLocationArgsRestart()
    • getLocationArgsStop

      String getLocationArgsStop()
    • isDomain

      boolean isDomain()
    • isInstance

      boolean isInstance()
    • getInfo

    • initializeInternal

      void initializeInternal()
    • createServiceInternal

      void createServiceInternal()
    • deleteService

      void deleteService()
    • deleteServiceInternal

      void deleteServiceInternal()