Package de.xima.fc.api

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 Summary

Constructors

Constructor	Description
APISettings()

Method Summary

Modifier and Type	Method	Description
void	changeScope(FrontendServer frontendServer)	Changes the scope of the current frontend server.
FrontendServer	getFServer()	Gets the current frontend server entity.
IHandlerProvider	getHandlerProvider()
IServerConfig	getServerConfig()	Returns the configuration of this server.
void	init(IHandlerProvider handlerProvider)	Initializes the handler provider.
boolean	isConnected()
boolean	isFrontendServer()	Deprecated. Check IWebAppDescriptor.getServerType() via the WebAppContext instead.
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
void	updateFrontendServerEntity()	Updates the currently used frontend server entity.

Methods inherited from class java.lang.Object

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

Constructor Detail

APISettings

public APISettings()

Method Detail

getServerConfig

public IServerConfig getServerConfig()

Returns the configuration of this server.

Returns:

the configuration of this 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.

updateFrontendServerEntity

public void updateFrontendServerEntity()

Updates the currently used frontend server entity.

isConnected

public boolean isConnected()

Returns:

true if the api is connected via frontend server or is a master server. false otherwise.

getHandlerProvider

public IHandlerProvider getHandlerProvider()

Returns:

the handler provider.

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

init

public void init(IHandlerProvider handlerProvider)

Initializes the handler provider.

Parameters:

handlerProvider - to be set.

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.