new module:SettingsClient(url, auth)
Creates a GeoServer REST SettingsClient instance.
Parameters:
| Name | Type | Description |
|---|---|---|
url |
String | The URL of the GeoServer REST API endpoint |
auth |
String | The Basic Authentication string |
- Source:
Methods
(async) getContactInformation() → {Object}
Get the contact information of the GeoServer.
- Source:
Throws:
Error if request fails
Returns:
An object with contact information
- Type
- Object
(async) getSettings() → {Object}
Get the complete GeoServer settings object.
- Source:
Throws:
Error if request fails
Returns:
Settings object
- Type
- Object
(async) updateContactInformation(addressopt, cityopt, countryopt, postalCodeopt, stateopt, emailopt, organizationopt, contactPersonopt, phoneNumberopt)
Update the contact information.
Deleting is not supported.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
address |
String |
<optional> |
The contact's address |
city |
String |
<optional> |
The contact's city |
country |
String |
<optional> |
The contact's country |
postalCode |
String |
<optional> |
The contact's postCode |
state |
String |
<optional> |
The contact's state |
email |
String |
<optional> |
The contact's email |
organization |
String |
<optional> |
The contact's organization |
contactPerson |
String |
<optional> |
The contact person |
phoneNumber |
String |
<optional> |
The contact's phone number |
- Source:
Throws:
Error if request fails
(async) updateProxyBaseUrl(proxyBaseUrl)
Update the global proxyBaseUrl setting.
Parameters:
| Name | Type | Description |
|---|---|---|
proxyBaseUrl |
String | The proxy base URL |
- Source:
(async) updateSettings(settings)
Update the global GeoServer settings.
Parameters:
| Name | Type | Description |
|---|---|---|
settings |
Object | The adapted GeoServer settings object |
- Source: