FrameworkOperationServiceImpl

string

The Spring bean identifier containing the service being called.frameworkOperationServiceImpl

string

default:"PROTOTYPE"

Bean scope. Use PROTOTYPE for service calls.

string

The public service method name shown in the signature below.

object[]

The method argument array. Each argument is passed as an object with index 0, 1, and so on; the value must match the Java parameter type.

Headers

POST /api/v1/bean/request
Content-Type: application/json
Lang-Context: en
Site-Context: my-site
Authorization: Bearer <token>

Send Lang-Context and Site-Context with every request. For protected methods, send the JWT in the Authorization header as Bearer <token>. Access: GUEST. Bearer Token: not required.

GUEST — unauthenticated users; only whitelist services are available.
USER — authentication is required; methods with USER checks are available.
ADMIN — full access to public methods of all services.
If a method checks a role internally, GUEST may receive null.

Methods

boolean

Argument	Type	Description
`val`	`String`	Passed through `args[0].0`.
`equalsToVal`	`String`	Passed through `args[1].1`.

isValueEquals

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isValueEquals",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

boolean

Argument	Type	Description
`value`	`String`	Passed through `args[0].0`.

isNotBlank

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isNotBlank",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Argument	Type	Description
`value`	`String`	Passed through `args[0].0`.

isBlank

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isBlank",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Argument	Type	Description
`value`	`String`	Passed through `args[0].0`.

isNotTrue

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isNotTrue",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Argument	Type	Description
`value`	`String`	Passed through `args[0].0`.

isTrue

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isTrue",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Argument	Type	Description
`path`	`String`	Passed through `args[0].0`.

isFileExists

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isFileExists",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Argument	Type	Description
`path`	`String`	Passed through `args[0].0`.

isFileExistsFromSystemRoot

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isFileExistsFromSystemRoot",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Argument	Type	Description
`path`	`String`	Passed through `args[0].0`.

isFileExistsFromUploadRoot

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isFileExistsFromUploadRoot",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Argument	Type	Description
—	—	This method does not accept arguments.

isLanguageDetection

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isLanguageDetection",
  "args": []
}

List<String>

Argument	Type	Description
—	—	This method does not accept arguments.

getActiveLanguages

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getActiveLanguages",
  "args": []
}

Map<String, String>

Argument	Type	Description
`date`	`String`	Passed through `args[0].0`.

getTimeFromDate

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getTimeFromDate",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String, String>

Argument	Type	Description
`pattern`	`String`	Passed through `args[0].0`.

getCurrentDate

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getCurrentDate",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String, String>

Argument	Type	Description
`date`	`String`	Passed through `args[0].0`.
`pattern`	`String`	Passed through `args[1].1`.

getFormattedDate

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getFormattedDate",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Map<String, String>

Argument	Type	Description
`timestamp`	`String`	Passed through `args[0].0`.
`pattern`	`String`	Passed through `args[1].1`.

getFormattedDateFromTimestamp

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getFormattedDateFromTimestamp",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Map<String, Object>

Argument	Type	Description
`date`	`String`	Passed through `args[0].0`.

getDaysTillEndDate

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getDaysTillEndDate",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String, Object>

Argument	Type	Description
`years`	`String`	Passed through `args[0].0`.
`pattern`	`String`	Passed through `args[1].1`.

getDatePlusYears

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getDatePlusYears",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Map<String, Object>

Argument	Type	Description
`timestamp`	`String`	Passed through `args[0].0`.

getDaysTillEndDateFromTimestamp

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getDaysTillEndDateFromTimestamp",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String, Object>

Argument	Type	Description
`val`	`String`	Passed through `args[0].0`.
`to`	`String`	Passed through `args[1].1`.

multiplyValueTo

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "multiplyValueTo",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Map<String, Object>

Argument	Type	Description
`val`	`String`	Passed through `args[0].0`.
`to`	`String`	Passed through `args[1].1`.

divideValueTo

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "divideValueTo",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Map<String, Object>

Argument	Type	Description
`val1`	`String`	Passed through `args[0].0`.
`val2`	`String`	Passed through `args[1].1`.

plusTwoValues

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "plusTwoValues",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Map<String, String>

Argument	Type	Description
`url`	`String`	Passed through `args[0].0`.
`dim`	`String`	Passed through `args[1].1`.

getFileSize

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getFileSize",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Map<String, String>

Argument	Type	Description
`filePath`	`String`	Passed through `args[0].0`.

getFileExtension

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getFileExtension",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String, String>

Argument	Type	Description
`text`	`String`	Passed through `args[0].0`.

getFirstLetter

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getFirstLetter",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String, String>

Argument	Type	Description
`seqName`	`String`	Passed through `args[0].0`.

getCurrentSequence

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getCurrentSequence",
  "args": [
    {
      "0": null
    }
  ]
}

List<Map<String,Object>>

Argument	Type	Description
`jsonArray`	`String`	Passed through `args[0].0`.

transformJsonArrayToList

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "transformJsonArrayToList",
  "args": [
    {
      "0": null
    }
  ]
}

String

Argument	Type	Description
—	—	This method does not accept arguments.

getLangCode

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getLangCode",
  "args": []
}

Map<String, String>

Argument	Type	Description
`str`	`String`	Passed through `args[0].0`.

toLowerCase

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "toLowerCase",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String, String>

Argument	Type	Description
`str`	`String`	Passed through `args[0].0`.

toUpperCase

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "toUpperCase",
  "args": [
    {
      "0": null
    }
  ]
}

Object

Argument	Type	Description
`endpoint`	`String`	Passed through `args[0].0`.
`method`	`String`	Passed through `args[1].1`.
`jsonAsString`	`String`	Passed through `args[2].2`.

restClientCall

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "restClientCall",
  "args": [
    {
      "0": null,
      "1": null,
      "2": null
    }
  ]
}

HashMap<Object, Object>

Argument	Type	Description
`itemName`	`String`	Passed through `args[0].0`.
`nestedKey`	`String`	Passed through `args[1].1`.
`database`	`String`	Passed through `args[2].2`.
`jsonObjString`	`String`	Passed through `args[3].3`.

parseNestedDatabaseDocs

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "parseNestedDatabaseDocs",
  "args": [
    {
      "0": null,
      "1": null,
      "2": null,
      "3": null
    }
  ]
}

String

Argument	Type	Description
`url`	`String`	Passed through `args[0].0`.

languageAwareUrl

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "languageAwareUrl",
  "args": [
    {
      "0": null
    }
  ]
}

WebSiteSettings

Argument	Type	Description
—	—	This method does not accept arguments.

getCurrentWebSiteSettings

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getCurrentWebSiteSettings",
  "args": []
}

LinkedHashMap<String, Object>

Argument	Type	Description
—	—	This method does not accept arguments.

getCurrentBrandingSiteSettings

{
  "beanId": "frameworkOperationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getCurrentBrandingSiteSettings",
  "args": []
}

Client integration

Clients

Services

REST API

Headers

Methods

isValueEquals

isNotBlank

isBlank

isNotTrue

isTrue

isFileExists

isFileExistsFromSystemRoot

isFileExistsFromUploadRoot

isLanguageDetection

getActiveLanguages

getTimeFromDate

getCurrentDate

getFormattedDate

getFormattedDateFromTimestamp

getDaysTillEndDate

getDatePlusYears

getDaysTillEndDateFromTimestamp

multiplyValueTo

divideValueTo

plusTwoValues

getFileSize

getFileExtension

getFirstLetter

getCurrentSequence

transformJsonArrayToList

getLangCode

toLowerCase

toUpperCase

restClientCall

parseNestedDatabaseDocs

languageAwareUrl

getCurrentWebSiteSettings

getCurrentBrandingSiteSettings

​Headers

​Methods

​isValueEquals

​isNotBlank

​isBlank

​isNotTrue

​isTrue

​isFileExists

​isFileExistsFromSystemRoot

​isFileExistsFromUploadRoot

​isLanguageDetection

​getActiveLanguages

​getTimeFromDate

​getCurrentDate

​getFormattedDate

​getFormattedDateFromTimestamp

​getDaysTillEndDate

​getDatePlusYears

​getDaysTillEndDateFromTimestamp

​multiplyValueTo

​divideValueTo

​plusTwoValues

​getFileSize

​getFileExtension

​getFirstLetter

​getCurrentSequence

​transformJsonArrayToList

​getLangCode

​toLowerCase

​toUpperCase

​restClientCall

​parseNestedDatabaseDocs

​languageAwareUrl

​getCurrentWebSiteSettings

​getCurrentBrandingSiteSettings

Headers

Methods

isValueEquals

isNotBlank

isBlank

isNotTrue

isTrue

isFileExists

isFileExistsFromSystemRoot

isFileExistsFromUploadRoot

isLanguageDetection

getActiveLanguages

getTimeFromDate

getCurrentDate

getFormattedDate

getFormattedDateFromTimestamp

getDaysTillEndDate

getDatePlusYears

getDaysTillEndDateFromTimestamp

multiplyValueTo

divideValueTo

plusTwoValues

getFileSize

getFileExtension

getFirstLetter

getCurrentSequence

transformJsonArrayToList

getLangCode

toLowerCase

toUpperCase

restClientCall

parseNestedDatabaseDocs

languageAwareUrl

getCurrentWebSiteSettings

getCurrentBrandingSiteSettings