Package org.cyclos.entities.system

Class CustomWebService

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.NetworkedEntity

org.cyclos.entities.BaseEntity

org.cyclos.entities.NamedEntity

org.cyclos.entities.ConfigurationEntity

org.cyclos.entities.system.CustomWebService

All Implemented Interfaces:

Cloneable, Comparable<NamedEntity>, HasNetwork, ProcessableForProxying, DefinesNetwork, IEntity, IInternalNamedEntity, INamedEntity, UsesScript

@Entity
public class CustomWebService
extends ConfigurationEntity
implements DefinesNetwork, UsesScript

A custom web service which may be invoked by an external application. Only supports running as Guest

Nested Class Summary

Nested classes/interfaces inherited from class org.cyclos.entities.SimpleEntity

SimpleEntity.EntityLoadNotifier

Constructor Summary

Constructors

Constructor	Description
CustomWebService()

Method Summary

Modifier and Type	Method	Description
String	getIpWhitelist()
HttpMethod	getMethod()
Network	getNetwork()	Returns the network this entity belongs to
String	getPassword()
RunAs	getRunAs()
CustomScript	getScript()
String	getScriptParameters()
CustomScriptUsedInType	getScriptUsedInType()	Returns the type of script usage
String	getUrlMappings()
String	getUsername()
InternetAddressList	getWhitelist()
boolean	isEnabled()	Indicates whether this entity is enabled
boolean	isUseIpWhitelist()
void	setMethod(HttpMethod method)
void	setNetwork(Network network)
void	setPassword(String password)
void	setRunAs(RunAs runAs)
void	setScript(CustomScript script)
void	setScriptParameters(String scriptParameters)
void	setUrlMappings(String urlMappings)
void	setUsername(String username)
void	setWhitelist(InternetAddressList whitelist)

Methods inherited from class org.cyclos.entities.ConfigurationEntity

getDescription, getInternalName, setDescription, setInternalName, toShortString, toString

Methods inherited from class org.cyclos.entities.NamedEntity

compareTo, getName, getNames, setName

Methods inherited from class org.cyclos.entities.BaseEntity

getDataTranslationType, getVersion

Methods inherited from class org.cyclos.entities.NetworkedEntity

isGlobal

Methods inherited from class org.cyclos.entities.SimpleEntity

equals, getId, hashCode, id, ids, isPersistent, isTransient, register, setId, uniqueIds, uniqueIds

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cyclos.model.IEntity

getId, matches

Methods inherited from interface org.cyclos.model.IInternalNamedEntity

matches

Methods inherited from interface org.cyclos.entities.ProcessableForProxying

getProxyClass

Constructor Detail

CustomWebService

public CustomWebService()

Method Detail

getIpWhitelist

public String getIpWhitelist()

getMethod

public HttpMethod getMethod()

getNetwork

public Network getNetwork()

Description copied from interface: HasNetwork

Returns the network this entity belongs to

Specified by:

getNetwork in interface HasNetwork

getPassword

public String getPassword()

getRunAs

public RunAs getRunAs()

getScript

public CustomScript getScript()

getScriptParameters

public String getScriptParameters()

getScriptUsedInType

public CustomScriptUsedInType getScriptUsedInType()

Description copied from interface: UsesScript

Returns the type of script usage

Specified by:

getScriptUsedInType in interface UsesScript

getUrlMappings

public String getUrlMappings()

getUsername

public String getUsername()

getWhitelist

public InternetAddressList getWhitelist()

isEnabled

public boolean isEnabled()

Description copied from interface: UsesScript

Indicates whether this entity is enabled

Specified by:

isEnabled in interface UsesScript

isUseIpWhitelist

public boolean isUseIpWhitelist()

setMethod

public void setMethod(HttpMethod method)

setNetwork

public void setNetwork(Network network)

Specified by:

setNetwork in interface DefinesNetwork

setPassword

public void setPassword(String password)

setRunAs

public void setRunAs(RunAs runAs)

setScript

public void setScript(CustomScript script)

setScriptParameters

public void setScriptParameters(String scriptParameters)

setUrlMappings

public void setUrlMappings(String urlMappings)

setUsername

public void setUsername(String username)

setWhitelist

public void setWhitelist(InternetAddressList whitelist)