Class APISettings

java.lang.Object
de.xima.fc.api.APISettings
public final class APISettings extends Object
Current settings of the API.
Author:
XIMA MEDIA GmbH

  • Constructor Details

    • APISettings

      public APISettings()

  • Method Details

    • changeScope

      public void changeScope(FrontendServer frontendServer)
      Changes the scope of the current frontend server.
      Parameters:
      frontendServer - the new frontend server to use or null to remove the current frontend server.

    • getFServer

      public FrontendServer getFServer()
      Gets the current frontend server entity.
      Returns:
      if the current server is a frontend server and is connected to a master server, the currently connected entity, null otherwise.

    • getHandlerProvider

      public IHandlerProvider getHandlerProvider()
      Returns:
      the handler provider.

    • init

      public void init(IHandlerProvider handlerProvider)
      Initializes the handler provider.
      Parameters:
      handlerProvider - to be set.

    • isConnected

      public boolean isConnected()
      Returns:
      true if the api is connected via frontend server or is a master server. false otherwise.

    • isFrontendServer

      @Deprecated public boolean isFrontendServer()
      Deprecated.
      Check IWebAppDescriptor.getServerType() via the WebAppContext instead.
      Returns:
      true if the current web app is a frontend server and false otherwise.

    • setFrontendServer

      @Deprecated public void setFrontendServer(boolean isFrontendServer)
      Deprecated.
      Do not change the state of the web app! For checking the type of web app use IWebAppDescriptor.getServerType() via the WebAppContext
      Parameters:
      isFrontendServer - to set

    • updateFrontendServerEntity

      public void updateFrontendServerEntity()
      Updates the currently used frontend server entity.