lucee.Componentrelax.DSLService
Copyright Ortus Solutions, Corp, All rights reserved www.ortussolutions.com --- The DSL Service
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
struct
|
APIDefinitions
Storage for API Definitions.
|
true
|
false
|
|
any
|
log
|
true
|
false
|
|
boolean
|
sessionsEnabled
Flag that tell us if the underlying application leverages session scope.
|
true
|
false
|
|
struct
|
settings
The relax module's settings.
|
true
|
false
|
Constructor Summary | |
---|---|
init(any settings)
Constructor. |
Method Summary | |
---|---|
DSLService
|
clearUserData()
Clears user data. |
any
|
getAPI(any name)
Get an API definition. |
string
|
getAPIDefinitions()
|
any
|
getLoadedAPI()
Get the loaded API representation. |
string
|
getLoadedAPIName()
Get the loaded API name. |
string
|
getLog()
|
string
|
getSessionsEnabled()
|
string
|
getSettings()
|
DSLService
|
importAPI(any name, any json)
Import a relax API. |
private any
|
injectMixin(any name, any UDF)
Injection method. |
boolean
|
isLoadedAPI()
Checks if an API is loaded or not, usually by checking the user's data. |
query
|
listAPIs()
Get a listing of all the APIs in the resources folder. |
any
|
loadAPI(any name)
Load an API into the service and get its representation. |
DSLService
|
processConfiguration(any dataCFC)
Process a relax configure method. |
any
|
setAPIDefinitions(struct APIDefinitions)
|
any
|
setLog(any log)
|
any
|
setSessionsEnabled(boolean sessionsEnabled)
|
any
|
setSettings(struct settings)
|
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
settings
- The relax module settings neededProperty Detail |
---|
Storage for API Definitions
access
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- logbox:logger:{this}serializable
- trueFlag that tell us if the underlying application leverages session scope
access
- publicrequired
- falsereturntype
- anyserializable
- trueThe relax module's settings
access
- publicrequired
- falsereturntype
- anyserializable
- trueMethod Detail |
---|
Clears user data
Get an API definition
name
- The name of the API to get.Get the loaded API representation
Get the loaded API name
Import a relax API
name
- The name of the API to importjson
- The JSON representation of the APIInjection method
name
UDF
Checks if an API is loaded or not, usually by checking the user's data
Get a listing of all the APIs in the resources folder
Load an API into the service and get its representation. This can be a Relax.cfc or a Relax.json representation.
name
- The API to loadProcess a relax configure method
dataCFC
- The data CFC to processAPIDefinitions
log
sessionsEnabled
settings