### ConnectorServer Start/Stop

Source: http://connid.tirasa.net/apidocs/1.6/index-all.html

Methods for starting and stopping the ConnectorServer.

```APIDOC
## ConnectorServer Start/Stop

### Description
Methods for managing the lifecycle of the `ConnectorServer`.

### Methods
- **start()**: Starts the server.
- **stop()**: Stops the server gracefully.

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### ConnectorServer Initialization and Singleton Access

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/server/ConnectorServer.html

Provides information on how to get the singleton instance of the ConnectorServer.

```APIDOC
## ConnectorServer

### Description
Provides access to the singleton instance of the ConnectorServer.

### Method
GET

### Endpoint
N/A (Instance retrieval)

### Constructor Details
#### ConnectorServer
`public ConnectorServer()`

### Method Details
#### newInstance
`public static ConnectorServer newInstance()`

Get the singleton instance of the `ConnectorServer`.

### Response Example
```json
{
  "instance": "ConnectorServer"
}
```
```

--------------------------------

### visitStartsWithFilter

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/common/objects/filter/FilterVisitor.html

Visits a 'starts with' filter. This method is part of the visitor pattern implementation.

```APIDOC
## visitStartsWithFilter

### Description
Visits a `starts with` filter.

### Method
N/A (Visitor method)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **result** (any) - Returns a visitor specified result.

#### Response Example
N/A
```

--------------------------------

### Get Data Value by Name and Sequence

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/contract/data/GroovyDataProvider.html

Acquires a property value marked with a given iteration number, for example, i1.testProperty.

```java
public Object get(String name, int sequenceNumber)
Aquire a property value marked with given iteration, for example i1.testProperty 

Specified by:
    `get` in interface `DataProvider` 

Parameters:
    `name` - the suffix     `sequenceNumber` -  

Returns:
    the property value
```

--------------------------------

### Constructor Details

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/common/VersionRange.html

Detailed explanation for the VersionRange constructor.

```APIDOC
## Constructor Details

### `VersionRange(Version low, boolean isLowInclusive, Version high, boolean isHighInclusive)`
Constructs a `VersionRange` with the specified lower and upper bounds and their inclusivity.
```

--------------------------------

### Configuration Loading

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/contract/data/GroovyDataProvider.html

Demonstrates how the system loads configuration settings, including database connection details, from a specified file.

```APIDOC
## Configuration Loading

### Description
Loads configuration settings from a file and initializes the ConnectorConfiguration object.

### Method
N/A (Code snippet)

### Endpoint
N/A (Code snippet)

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Configuration Details

### Description
Defines the structure for account configuration initialization.

### Method
N/A (Code snippet)

### Endpoint
N/A (Code snippet)

### Parameters
N/A

### Request Example
```groovy
configuration {
  init.driver="foo"
  init.hostName="bar"
  init.port="boo"
}
```

### Response
N/A
```

--------------------------------

### GET getLatestSyncToken

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/spi/operations/SyncOp.html

Retrieves the most recent synchronization token for a specific object class, allowing clients to start synchronization from the current point in time.

```APIDOC
## GET getLatestSyncToken

### Description
Returns the token corresponding to the most recent synchronization event for the specified object class.

### Parameters
#### Query Parameters
- **objectClass** (ObjectClass) - Required - The class of object for which to find the most recent synchronization event.

### Response
#### Success Response (200)
- **SyncToken** (Object) - A token if synchronization events exist; otherwise null.
```

--------------------------------

### GET /sync/latest-token

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/api/operations/SyncApiOp.html

Retrieves the most recent synchronization token for a specified object class, allowing clients to start receiving events from the current point in time.

```APIDOC
## GET /sync/latest-token

### Description
Returns the token corresponding to the most recent synchronization event for any instance of the specified object class.

### Method
GET

### Endpoint
/sync/latest-token

### Parameters
#### Query Parameters
- **objectClass** (string) - Required - The class of object for which to find the most recent synchronization event.

### Response
#### Success Response (200)
- **SyncToken** (object) - The token representing the most recent synchronization event, or null if none exist.
```

--------------------------------

### Connector Initialization

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/spi/class-use/Configuration.html

Methods for initializing connectors with configuration objects.

```APIDOC
## Connector.init(Configuration cfg)

### Description
Initializes the connector with its specific configuration.

### Method
void

### Parameters
#### Request Body
- **cfg** (Configuration) - Required - The configuration object to initialize the connector.
```

--------------------------------

### Get Class Documentation

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/contract/data/groovy/Get.html

Documentation for the Get class, which extends Lazy and provides functionality for lazily getting properties.

```APIDOC
## Get Class

### Description
Lazily get a property. This is a Helper class, users of tests will access methods: `Lazy.random(Object)` and `Lazy.get(Object)`.

### Fields inherited from class org.identityconnectors.contract.data.groovy.Lazy
- `successors` (type unknown) - Description
- `value` (type unknown) - Description

### Constructor Summary

| Modifier | Constructor | Description |
|---|---|---|
| `protected` | `Get(Object prop)` | Constructor for the Get class. |

### Method Summary

#### Methods inherited from class org.identityconnectors.contract.data.groovy.Lazy
- `get()`
- `getSuccessors()`
- `getValue()`
- `plus(Object other)`
- `plus(Object other)`
- `random()`
- `random(Object obj)`
- `setSuccessors(Object successors)`
- `setValue(Object value)`

#### Methods inherited from class java.lang.Object
- `clone()`
- `equals(Object obj)`
- `finalize()`
- `getClass()`
- `hashCode()`
- `notify()`
- `notifyAll()`
- `toString()`
- `wait()`
- `wait(long timeout)`
- `wait(long timeout, int nanos)`

### Constructor Details

#### Get
```java
protected Get(Object prop)
```

**Description:** Constructor for the Get class.
```

--------------------------------

### ConnectorServer.newInstance()

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/server/class-use/ConnectorServer.html

Retrieves the singleton instance of the ConnectorServer.

```APIDOC
## GET /org.identityconnectors.framework.server/ConnectorServer/newInstance

### Description
Get the singleton instance of the ConnectorServer.

### Method
GET

### Endpoint
/org.identityconnectors.framework.server/ConnectorServer/newInstance

### Response
#### Success Response (200)
- **ConnectorServer** (object) - The singleton instance of the ConnectorServer.
```

--------------------------------

### GUID Constructor

Source: http://connid.tirasa.net/apidocs/1.6/index-all.html

Details for the constructor of the GUID class.

```APIDOC
## GUID Constructor

### Description
Creates a globally unique identifier.

### Method
GUID()

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### Method Summary

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/common/VersionRange.html

Lists all available methods for the VersionRange class.

```APIDOC
## Method Summary

### `boolean equals(Object obj)`
Compares this VersionRange to another object for equality.

### `Version getCeiling()`
Returns the upper bound of the version range.

### `Version getFloor()`
Returns the lower bound of the version range.

### `int hashCode()`
Returns a hash code value for this VersionRange.

### `boolean isCeilingInclusive()`
Checks if the upper bound of the range is inclusive.

### `boolean isEmpty()`
Returns whether this version range is empty.

### `boolean isExact()`
Returns whether this version range contains only a single version.

### `boolean isFloorInclusive()`
Checks if the lower bound of the range is inclusive.

### `boolean isInRange(Version version)`
Checks if a given version falls within this range.

### `static VersionRange parse(String range)`
Creates a version range from the specified string.

### `String toString()`
Returns a string representation of the version range.
```

--------------------------------

### GUID Class Methods

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/common/GUID.html

Methods available for the GUID class to handle unique identifier operations.

```APIDOC
## GUID Class Methods

### Description
The GUID class is used to create and manage globally unique identifiers. It provides standard object comparison and string conversion methods.

### Methods
- **toString()** (String) - Returns the string version of the VMID.
- **hashCode()** (int) - Returns the hash code of the VMID.
- **equals(Object o)** (boolean) - Compares this GUID with another object for equality based on the VMID.

### Usage Example
```java
GUID guid = new GUID();
String id = guid.toString();
boolean isEqual = guid.equals(otherObject);
```
```

--------------------------------

### ConnectorServer Lifecycle Management

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/server/ConnectorServer.html

Methods for starting, stopping, and checking the status of the ConnectorServer.

```APIDOC
## Lifecycle Management

### Description
Provides methods to control the lifecycle of the ConnectorServer, including starting, stopping, and checking its operational status.

### Methods
- `start()`: Starts the server.
- `stop()`: Stops the server gracefully.
- `isStarted()`: Checks if the server is started.
- `awaitStop()`: Waits for the server to stop.
- `getStartTime()`: Retrieves the last start time of the server.

### Method Details
#### start
`public abstract void start()`

Starts the server. All server settings must be configured prior to calling. The following methods are required to be called:
  * `setBundleURLs(List)`
  * `setPort(int)`
  * `setKeyHash(String)`

#### stop
`public abstract void stop()`

Stops the server gracefully. Returns when all in-progress connections have been serviced.

#### isStarted
`public abstract boolean isStarted()`

Return true if the server is started. Note that started is a logical state (start method has been called). It does not necessarily reflect the health of the server.

Returns:
    true if the server is started.

#### awaitStop
`public abstract void awaitStop() throws InterruptedException`

Waits for the server to stop. This method may throw an `InterruptedException`.

#### getStartTime
`public abstract Long getStartTime()`

Gets the time when the servers was started last time. `System.currentTimeMillis()`

Returns:
    last start dateTime in milliseconds

### Response Example (isStarted)
```json
{
  "isStarted": true
}
```

### Response Example (getStartTime)
```json
{
  "startTime": 1678886400000
}
```
```

--------------------------------

### Load configuration resources

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/test/common/TestHelpers.html

These methods define the search paths for configuration files based on prefix and optional configuration parameters.

```java
loader.getResource(prefix + "/config/" + cfg + "/config.groovy")
```

```java
loader.getResource(prefix + "/config-private/config.groovy")
```

```java
loader.getResource(prefix + "/config-private/" + cfg + "/config.groovy")
```

--------------------------------

### Filter by Attribute - Starts With

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/common/objects/filter/FilterBuilder.html

Selects ConnectorObjects where an attribute's value starts with a specified substring.

```APIDOC
## POST /api/filter/startsWith

### Description
Select only an input `ConnectorObject` with a value for the specified `Attribute` that contains as an _initial substring_ the value of the specified `Attribute`.

### Method
POST

### Endpoint
/api/filter/startsWith

### Parameters
#### Request Body
- **attr** (Attribute) - Required - An `Attribute` object containing exactly one value to test against each value of the corresponding `ConnectorObject` attribute.

### Request Example
```json
{
  "attr": {
    "hairColor": "b"
  }
}
```

### Response
#### Success Response (200)
- **Filter** (Filter) - An instance of `Filter` whose `accept()` method will return `true` if at least one value of the corresponding attribute of the `ConnectorObject` _contains as its first part_ the value of the specified `Attribute`; otherwise `false`.

#### Response Example
```json
{
  "filter": "..."
}
```
```

--------------------------------

### Get Data Value (with Default)

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/contract/data/GroovyDataProvider.html

The main get method for property lookup. Allows specifying whether to use a default value.

```java
public Object get(String name, String type, boolean useDefault)
Main get method. Property lookup starts here.
```

--------------------------------

### LocalConnectorInfoImpl Constructors and Methods

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/impl/api/local/LocalConnectorInfoImpl.html

Details on the constructors and instance methods available in the LocalConnectorInfoImpl class.

```APIDOC
## LocalConnectorInfoImpl API Documentation

### Description
Provides information about a connector, including its class, configuration, and pooling support.

### Constructors

#### LocalConnectorInfoImpl()

*   **Description**: Initializes a new instance of the `LocalConnectorInfoImpl` class.

### Methods

#### getConnectorClass()

*   **Description**: Retrieves the `Class` object representing the connector.
*   **Returns**: `Class<? extends Connector>` - The connector class.

#### getConnectorConfigurationClass()

*   **Description**: Retrieves the `Class` object representing the connector's configuration.
*   **Returns**: `Class<? extends Configuration>` - The connector configuration class.

#### isConfigurationStateless()

*   **Description**: Checks if the connector configuration is stateless.
*   **Returns**: `boolean` - `true` if stateless, `false` otherwise.

#### isConnectorPoolingSupported()

*   **Description**: Checks if connector pooling is supported.
*   **Returns**: `boolean` - `true` if pooling is supported, `false` otherwise.

#### setConnectorClass(Class<? extends Connector> clazz)

*   **Description**: Sets the `Class` object for the connector.
*   **Parameters**:
    *   **clazz** (Class<? extends Connector>) - Required - The connector class to set.

#### setConnectorConfigurationClass(Class<? extends Configuration> c)

*   **Description**: Sets the `Class` object for the connector's configuration.
*   **Parameters**:
    *   **c** (Class<? extends Configuration>) - Required - The connector configuration class to set.

#### toRemote()

*   **Description**: Converts this `LocalConnectorInfoImpl` instance to a `RemoteConnectorInfoImpl` instance.
*   **Returns**: `RemoteConnectorInfoImpl` - The remote connector information.

### Inherited Methods

*   **From `AbstractConnectorInfo`**: `createDefaultAPIConfiguration`, `getConnectorCategory`, `getConnectorCategoryKey`, `getConnectorDisplayName`, `getConnectorDisplayNameKey`, `getConnectorKey`, `getDefaultAPIConfiguration`, `getMessages`, `setConnectorCategoryKey`, `setConnectorDisplayNameKey`, `setConnectorKey`, `setDefaultAPIConfiguration`, `setMessages`
*   **From `java.lang.Object`**: `clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait`
```

--------------------------------

### Method Details

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/common/VersionRange.html

Detailed explanations for each method in the VersionRange class.

```APIDOC
## Method Details

### `parse(String range)`
`public static VersionRange parse(String range)`
Creates a version range from the specified string. 

**Grammar:**
```
 range ::= interval | at least
 interval ::= ( '[' | '(' ) left ',' right ( ']' | ')' )
 left ::= version
 right ::= version
 at least ::= version
```

**Parameters:**
- `range` (String) - String representation of the version range. Versions must contain no whitespace. Other whitespace is ignored.

**Throws:**
- `IllegalArgumentException` - If `range` is improperly formatted.

### `getFloor()`
`public Version getFloor()`
Returns the lower bound (floor) of this version range.

### `isFloorInclusive()`
`public boolean isFloorInclusive()`
Returns `true` if the lower bound of this version range is inclusive, `false` otherwise.

### `getCeiling()`
`public Version getCeiling()`
Returns the upper bound (ceiling) of this version range.

### `isCeilingInclusive()`
`public boolean isCeilingInclusive()`
Returns `true` if the upper bound of this version range is inclusive, `false` otherwise.

### `isInRange(Version version)`
`public boolean isInRange(Version version)`
Checks if the given `version` is within the bounds of this `VersionRange`.

### `isExact()`
`public boolean isExact()`
Returns whether this version range contains only a single version.

### `isEmpty()`
`public boolean isEmpty()`
Returns whether this version range is empty.

### `equals(Object obj)`
`public boolean equals(Object obj)`
Compares this `VersionRange` to the specified object. Returns `true` if and only if the argument is not `null` and is a `VersionRange` object that represents the same set of versions as this object.

### `hashCode()`
`public int hashCode()`
Returns a hash code value for this `VersionRange`.

### `toString()`
`public String toString()`
Returns a string representation of this `VersionRange`.
```

--------------------------------

### Get Logger Instance

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/common/logging/Log.html

Obtain a logger instance for a specific class. This is the standard way to get a logger to use throughout your class.

```java
public static Log getLog(Class<?> clazz)
```

```java
private static final Log LOG = Log.getLog(MyClass.class);
```

--------------------------------

### GET /schema

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/api/operations/SchemaApiOp.html

Retrieves the basic schema of the Connector.

```APIDOC
## GET /schema

### Description
Retrieve the basic schema of this `Connector`.

### Method
GET

### Endpoint
/schema

### Response
#### Success Response (200)
- **Schema** (Schema) - The schema of the Connector.
```

--------------------------------

### Initialize Connector Configuration

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/contract/data/GroovyDataProvider.html

Loads configuration settings from a specified file into a ConnectorConfiguration object.

```java
static final String DEFAULT_CONFIGURATINON = "configuration.init"

// attempt to create the database in the directory..
config = new ConnectorConfiguration();

// LOAD THE submap in 'configuration' **prefix to 'config' object.
dataProvider.loadConfiguration(DEFAULT_CONFIGURATINON, config);
```

--------------------------------

### Activator Sample Class

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/impl/api/osgi/internal/package-summary.html

A sample class documentation for Activator.

```APIDOC
## Activator

### Description
This is a sample class documentation for the Activator.

### Class
Activator
```

--------------------------------

### TstStatefulConnector Initialization and Configuration

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/testconnector/TstStatefulConnector.html

Details on how to initialize the TstStatefulConnector with configuration and retrieve the current configuration.

```APIDOC
## POST /api/connector/init

### Description
Initializes the connector with its configuration.

### Method
POST

### Endpoint
/api/connector/init

### Parameters
#### Request Body
- **cfg** (Configuration) - Required - An instance of the Configuration object populated with information to initialize the Connector.

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

## GET /api/connector/getConfiguration

### Description
Retrieves the configuration that was passed to the Connector's init method.

### Method
GET

### Endpoint
/api/connector/getConfiguration

### Response
#### Success Response (200)
- **configuration** (Configuration) - The configuration object used to initialize the connector.

#### Response Example
{
  "configuration": {
    "example": "configuration details"
  }
}
```

--------------------------------

### sync

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/common/objects/class-use/ObjectClass.html

Synchronizes objects starting from a specific token.

```APIDOC
## sync

### Description
Synchronizes changes for an object class starting from the provided SyncToken.

### Parameters
- **objectClass** (ObjectClass) - Required
- **token** (SyncToken) - Required
- **handler** (SyncResultsHandler) - Required
- **options** (OperationOptions) - Required
```

--------------------------------

### GET /schema

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/testconnector/TstConnector.html

Describes the types of objects supported by the connector.

```APIDOC
## GET /schema

### Description
Describes the types of objects this Connector supports. This operation may require configuration information.

### Method
GET

### Response
#### Success Response (200)
- **schema** (Schema) - The basic schema supported by the connector.
```

--------------------------------

### TstStatefulConnector: init

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/spi/class-use/Configuration.html

Initializes the TstStatefulConnector with a given configuration.

```APIDOC
## TstStatefulConnector.init

### Description
Initializes the TstStatefulConnector with a given configuration.

### Method
`void`

### Endpoint
N/A (Method within a class)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (void)
This method does not return a value.

#### Response Example
None
```

--------------------------------

### Constructor Summary

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/common/VersionRange.html

Details the constructor for creating a VersionRange object.

```APIDOC
## Constructor Summary

### `VersionRange(Version low, boolean isLowInclusive, Version high, boolean isHighInclusive)`
Creates a new VersionRange with specified low and high bounds and inclusivity.
```

--------------------------------

### Get Instance Name

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/impl/api/AbstractConnectorFacade.html

Retrieves the name of the current instance.

```java
protected String getInstanceName()
```

--------------------------------

### GET /getConnectorInfos

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/impl/api/osgi/internal/OsgiConnectorInfoManagerImpl.html

Retrieves a list of all available ConnectorInfo instances.

```APIDOC
## GET /getConnectorInfos

### Description
Returns the list of ConnectorInfo instances.

### Method
GET

### Response
#### Success Response (200)
- **List<ConnectorInfo>** (Array) - The list of ConnectorInfo instances.
```

--------------------------------

### ConfigurationPropertyImpl Class Overview

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/impl/api/ConfigurationPropertyImpl.html

Provides details about the ConfigurationPropertyImpl class, including its constructors and methods for managing configuration properties.

```APIDOC
## ConfigurationPropertyImpl

This class implements the `ConfigurationProperty` interface and extends `java.lang.Object`. It is used to represent configuration properties within the system.

### Constructor Summary

- `ConfigurationPropertyImpl()`: Initializes a new instance of the `ConfigurationPropertyImpl` class.

### Method Summary

#### Instance Methods

- `boolean equals(Object o)`: Compares this instance to another object for equality.
- `SuggestedValues getAllowedValues()`: Returns the list of allowed values for the property.
- `String getDisplayMessageKey()`: Gets the message key for the display name.
- `String getDisplayName(String def)`: Gets the display name for this configuration property, using a default value if not found.
- `String getGroup(String def)`: Gets the name of the group for this configuration property, using a default value if not found.
- `String getGroupMessageKey()`: Gets the message key for the group name.
- `String getHelpMessage(String def)`: Gets the help message from the message catalog, using a default value if not found.
- `String getHelpMessageKey()`: Gets the message key for the help message.
- `String getName()`: Gets the unique name of the configuration property.
- `Set<Class<? extends APIOperation>> getOperations()`: Gets the set of operations for which this property must be specified.
- `int getOrder()`: Gets the order of this property.
- `ConfigurationPropertiesImpl getParent()`: Gets the parent configuration properties object.
- `Class<?> getType()`: Gets the type of the property.
- `Object getValue()`: Gets the value of the property.
- `int hashCode()`: Returns a hash code value for the object.
- `boolean isConfidential()`: Checks if this property is confidential and should be encrypted.
- `boolean isRequired()`: Checks if this property is required.
- `void setAllowedValues(SuggestedValues allowedValues)`: Sets the allowed values for the property.
- `void setConfidential(boolean confidential)`: Sets whether this property is confidential.
- `void setDisplayMessageKey(String key)`: Sets the message key for the display name.
- `void setGroupMessageKey(String key)`: Sets the message key for the group name.
- `void setHelpMessageKey(String key)`: Sets the message key for the help message.
- `void setName(String name)`: Sets the unique name of the configuration property.
- `void setOperations(Set<Class<? extends APIOperation>> set)`: Sets the set of operations for which this property must be specified.
- `void setOrder(int order)`: Sets the order of this property.
- `void setParent(ConfigurationPropertiesImpl parent)`: Sets the parent configuration properties object.
- `void setRequired(boolean v)`: Sets whether this property is required.
- `void setType(Class<?> type)`: Sets the type of the property.
- `void setValue(Object value)`: Sets the value of the property.
```

--------------------------------

### ConnectionProcessor.run() Method

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/server/impl/ConnectionProcessor.html

Executes the connection processing logic.

```APIDOC
## void run()

### Description
Executes the connection processing logic. This method is part of the `Runnable` interface.

### Method
void

### Endpoint
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
None

#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### GET /findConnectorInfo

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/impl/api/osgi/internal/OsgiConnectorInfoManagerImpl.html

Retrieves the ConnectorInfo associated with a specific ConnectorKey.

```APIDOC
## GET /findConnectorInfo

### Description
Returns the ConnectorInfo that is associated with the specified ConnectorKey.

### Method
GET

### Parameters
#### Query Parameters
- **key** (ConnectorKey) - Required - The key of a connector.

### Response
#### Success Response (200)
- **ConnectorInfo** (Object) - The ConnectorInfo or null if none was associated.
```

--------------------------------

### SyncDeltaBuilder Constructors

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/common/objects/SyncDeltaBuilder.html

Provides information on how to initialize a SyncDeltaBuilder.

```APIDOC
## SyncDeltaBuilder()

### Description
Create a new `SyncDeltaBuilder`.

### Method
Constructor

### Endpoint
N/A

## SyncDeltaBuilder(SyncDelta delta)

### Description
Creates a new `SyncDeltaBuilder` whose values are initialized to those of the delta.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### GET /connector/pool

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/impl/api/local/class-use/ConnectorPoolManager.ConnectorPoolKey.html

Retrieves an existing object pool for a connector.

```APIDOC
## GET /connector/pool

### Description
Get an object pool for this connector if it was created before.

### Method
GET

### Endpoint
/connector/pool

### Query Parameters
- **connectorPoolKey** (ConnectorPoolManager.ConnectorPoolKey) - Required - The key identifying the connector pool.

### Response
#### Success Response (200)
- **ObjectPool<PoolableConnector>** - The existing object pool.
```

--------------------------------

### Get Uid Attribute

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/common/objects/AttributeUtil.html

Retrieves the Uid from a set of attributes.

```APIDOC
## getUidAttribute

### Description
Get the `Uid` from the specified set of attributes.

### Method
`public static Uid getUidAttribute(Set<Attribute> attrs)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **Uid** - null if the set does not contain a `Uid` object the first one found.

#### Response Example
None
```

--------------------------------

### Constructor for SearchImpl

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/impl/api/local/operations/class-use/ConnectorOperationalContext.html

Initializes the search operation, requiring the operational context and the connector. This constructor sets up the operation works.

```java
SearchImpl(ConnectorOperationalContext context,  Connector connector)
```

--------------------------------

### GET /OperationOptions/getOptions

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/common/objects/OperationOptions.html

Retrieves the map of all configured operation options.

```APIDOC
## GET /OperationOptions/getOptions

### Description
Returns a map containing all currently set operation options. Each value must be of a type supported by the ObjectSerializerFactory.

### Response
#### Success Response (200)
- **options** (Map<String, Object>) - A map of the configured operation options.
```

--------------------------------

### ConfigurationProperty Annotation

Source: http://connid.tirasa.net/apidocs/1.6/index-all.html

Documentation for the helpMessageKey element within the ConfigurationProperty annotation.

```APIDOC
## ConfigurationProperty.helpMessageKey()

### Description
An element in the ConfigurationProperty annotation used to change the default help message key.
```

--------------------------------

### GET /connectors

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/api/ConnectorInfoManager.html

Retrieves a list of all available ConnectorInfo instances.

```APIDOC
## GET /connectors

### Description
Retrieves the list of `ConnectorInfo` instances.

### Method
GET

### Endpoint
/connectors

### Response
#### Success Response (200)
- **List<ConnectorInfo>** - The list of `ConnectorInfo` instances.

#### Response Example
```json
[
  {
    "connectorId": "exampleConnector1",
    "displayName": "Example Connector 1",
    "version": "1.0.0"
  },
  {
    "connectorId": "exampleConnector2",
    "displayName": "Example Connector 2",
    "version": "1.1.0"
  }
]
```
```

--------------------------------

### Connector Configuration and Facade

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/api/package-summary.html

Details on how to configure a connector instance and obtain a ConnectorFacade for invoking operations.

```APIDOC
## Connector Configuration and Facade

### Description
This section details the process of configuring a connector instance and obtaining a `ConnectorFacade` to interact with the connector's operations.

### Configuration Steps
1. **Obtain Default Configuration**: Use `ConnectorInfo` to get the default configuration for a connector.
2. **List Configuration Properties**: Identify available configuration properties using the connector's metadata.
3. **Set Configuration Values**: Provide values for connector-specific properties (e.g., hostname, port, credentials).
4. **Create APIConfiguration**: Assemble the tailored configuration into an `APIConfiguration` object.

### Obtaining ConnectorFacade
- **Method**: `ConnectorFacadeFactory.newInstance(APIConfiguration)`
- **Description**: Creates an instance of `ConnectorFacade` representing a configured connector.

### ConnectorFacade Usage
- Once obtained, the `ConnectorFacade` instance can be used to invoke any supported operations.
- The `ConnectorFacade` describes the object-classes and operations it supports.
```

--------------------------------

### Get Test Name

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/contract/test/CreateApiOpTests.html

Retrieves the name of the current test.

```java
public String getTestName()
```

--------------------------------

### newInstance(ConnectorInfo connectorInfo, String config)

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/impl/api/ManagedConnectorFacadeFactoryImpl.html

Creates a new instance of ConnectorFacade using connector information and a serialized configuration string.

```APIDOC
## newInstance(ConnectorInfo connectorInfo, String config)

### Description
Get a new instance of ConnectorFacade using connector info and a Base64 serialized APIConfiguration instance.

### Parameters
#### Request Body
- **connectorInfo** (ConnectorInfo) - Required - Information about the connector.
- **config** (String) - Required - A Base64 serialized APIConfiguration instance.

### Response
#### Success Response (200)
- **ConnectorFacade** (Object) - The facade instance to call API operations against.
```

--------------------------------

### ConnectionProcessor Constructor

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/server/impl/ConnectionProcessor.html

Initializes a new instance of the ConnectionProcessor class.

```APIDOC
## ConnectionProcessor(ConnectorServer server, Socket socket)

### Description
Initializes a new instance of the `ConnectionProcessor` class.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
None

#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### GET Attributes

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/contract/data/DataProvider.html

Retrieves connector or test suite attributes.

```APIDOC
## GET /attributes

### Description
Retrieves connector or test suite attributes by property name.

### Parameters
#### Query Parameters
- **propName** (String) - Required
- **testName** (String) - Optional

### Response
#### Success Response (200)
- **value** (Object) - The attribute value

### Errors
- **ObjectNotFoundException** - Thrown if the attribute cannot be found.
```

--------------------------------

### GET /org.identityconnectors.common.security/EncryptorFactory/getInstance

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/common/security/class-use/EncryptorFactory.html

Retrieves the singleton instance of the EncryptorFactory class.

```APIDOC
## GET /org.identityconnectors.common.security/EncryptorFactory/getInstance

### Description
Retrieves the singleton instance of the EncryptorFactory, which is used for managing encryption operations within the framework.

### Method
GET

### Endpoint
org.identityconnectors.common.security.EncryptorFactory.getInstance()

### Response
#### Success Response (200)
- **instance** (EncryptorFactory) - The singleton instance of the EncryptorFactory.
```

--------------------------------

### Constructor for DiscoverConfigurationImpl

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/impl/api/local/operations/class-use/ConnectorOperationalContext.html

Constructor for DiscoverConfigurationImpl, requiring the operational context and the connector.

```java
DiscoverConfigurationImpl(ConnectorOperationalContext context,  Connector connector)
```

--------------------------------

### LocalConnectorInfoImpl Constructor

Source: http://connid.tirasa.net/apidocs/1.6/index-all.html

Constructs a LocalConnectorInfoImpl instance.

```APIDOC
## LocalConnectorInfoImpl Constructor

### Description
Constructs a LocalConnectorInfoImpl instance.

### Constructor
`LocalConnectorInfoImpl()`

### Class
`org.identityconnectors.framework.impl.api.local.LocalConnectorInfoImpl`
```

--------------------------------

### GET /api/sync/token

Source: http://connid.tirasa.net/apidocs/1.6/index-all.html

Retrieves the synchronization token associated with a change delta.

```APIDOC
## GET /api/sync/token

### Description
Returns the SyncToken of the object that changed.

### Method
GET
```

--------------------------------

### Get API Configuration

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/impl/api/AbstractConnectorFacade.html

Retrieves the current API configuration implementation.

```java
protected final APIConfigurationImpl getAPIConfiguration()
```

--------------------------------

### Static Methods: getSupportedLanguages and newInstance

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/common/script/ScriptExecutorFactory.html

Methods for retrieving supported scripting languages and creating a factory instance for a specific language.

```APIDOC
## Static Methods

### getSupportedLanguages
- **Description**: Returns the set of supported languages.
- **Returns**: Set<String> - The set of supported languages.

### newInstance
- **Description**: Creates a ScriptExecutorFactory for the given language.
- **Parameters**:
  - **language** (String) - Required - The name of the language.
- **Returns**: ScriptExecutorFactory - The script executor factory.
- **Throws**: IllegalArgumentException - If the given language is not supported.
```

--------------------------------

### Get Operation Implementation

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/impl/api/AbstractConnectorFacade.html

Retrieves the implementation for a specific API operation.

```java
protected abstract APIOperation getOperationImplementation(Class<? extends APIOperation> api)
```

--------------------------------

### POST /test

Source: http://connid.tirasa.net/apidocs/1.6/net/tirasa/connid/commons/scripted/AbstractScriptedConnector.html

Tests the configuration with the connector.

```APIDOC
## POST /test

### Description
Tests the current Configuration with the connector to ensure connectivity and validity.

### Method
POST

### Endpoint
/test
```

--------------------------------

### GET /getObject

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/common/objects/class-use/Uid.html

Retrieve a specific connector object using its Uid.

```APIDOC
## GET /getObject

### Description
Get a particular ConnectorObject based on the Uid.

### Method
GET

### Parameters
#### Query Parameters
- **objectClass** (ObjectClass) - Required - The class of the object.
- **uid** (Uid) - Required - The unique identifier of the object.
- **options** (OperationOptions) - Optional - Additional operation options.

### Response
#### Success Response (200)
- **ConnectorObject** (ConnectorObject) - The retrieved object.
```

--------------------------------

### ConnectorInfoManagerFactoryImpl Constructor

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/impl/api/ConnectorInfoManagerFactoryImpl.html

Initializes a new instance of the ConnectorInfoManagerFactoryImpl class.

```APIDOC
## ConnectorInfoManagerFactoryImpl()

### Description
Initializes a new instance of the ConnectorInfoManagerFactoryImpl class.

### Method
CONSTRUCTOR

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None
```

--------------------------------

### Get Special Attributes

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/common/objects/AttributeUtil.html

Retrieves special attributes from a set of attributes.

```APIDOC
## getSpecialAttributes

### Description
Get the special attributes from the specified set.

### Method
`public static Set<Attribute> getSpecialAttributes(Set<Attribute> attrs)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **Set<Attribute>** - A set containing special attributes.

#### Response Example
None
```

--------------------------------

### Get Basic Attributes

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/common/objects/AttributeUtil.html

Filters out special attributes from a set of attributes.

```APIDOC
## getBasicAttributes

### Description
Filter out any special attribute from the specified set. Special attributes include `Name`, `Uid`, and `OperationalAttributes`.

### Method
`public static Set<Attribute> getBasicAttributes(Set<Attribute> attrs)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **Set<Attribute>** - a set that only contains plain attributes or empty.

#### Response Example
None
```

--------------------------------

### LoggingProxy Constructor

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/impl/api/LoggingProxy.html

Initializes a new instance of the LoggingProxy class.

```APIDOC
## Constructor: LoggingProxy

### Description
Constructs a proxy responsible for logging operations from the API.

### Parameters
- **api** (Class<? extends APIOperation>) - Required - The API operation class.
- **target** (Object) - Required - The target object to proxy.
- **instanceName** (String) - Required - The name of the instance.
```

--------------------------------

### Get Single Value

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/common/objects/AttributeUtil.html

Retrieves the Object value from a single-valued attribute.

```APIDOC
## getSingleValue

### Description
Get the `Object` value from the specified (single-valued) attribute.

### Method
`public static Object getSingleValue(Attribute attr)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **Object** - `null` if the attribute's list of values is `null` or empty.

#### Response Example
None
```

--------------------------------

### SyncApiOpTests - Method Details

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/contract/test/SyncApiOpTests.html

Detailed explanations for key methods within the SyncApiOpTests class.

```APIDOC
## Method Details

### getAPIOperations
```java
public Set<Class<? extends APIOperation>> getAPIOperations()
```
Ask the subclasses for the `APIOperation`. Method returns set of required API operations that are prerequisites for running certain contract test.

Specified by:
`getAPIOperations` in class `ContractTestBase`

### testRun
```java
protected void testRun(ObjectClass objectClass)
```
This method will be called configured number of times

Specified by:
`testRun` in class `ObjectClassRunner`

### testSyncWithoutAttrsToGet
```java
@ParameterizedTest
@MethodSource("objectClasses")
public void testSyncWithoutAttrsToGet(ObjectClass objectClass)
```
Test Sync without attrsToGet.

### testLatestSyncToken
```java
@ParameterizedTest
@MethodSource("objectClasses")
public void testLatestSyncToken(ObjectClass objectClass)
```
Tests that `SyncApiOp.getLatestSyncToken(ObjectClass)` returns really the latest sync token which is available.

### getTestName
```java
public String getTestName()
```
Gets Test name

Specified by:
`getTestName` in class `ObjectClassRunner`

Returns:
Test Name

### canSyncAfterOp
```java
protected static boolean canSyncAfterOp(Class<? extends APIOperation> operation)
```
Returns true if tests are configured to test connector's sync after specified operation. Some connectors implement sync but are not capable to sync all changes' types.
```

--------------------------------

### Get Map Value

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/common/objects/AttributeUtil.html

Retrieves the map value from a single-valued attribute.

```APIDOC
## getMapValue

### Description
Get the map value from the specified (single-valued) attribute.

### Method
`public static Map<String,Object> getMapValue(Attribute attr)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **Map<String,Object>** - null if the value is null otherwise the map value for the attribute.

#### Response Example
None

### Throws
- `ClassCastException` - if the object in the attribute is not an `Map`.
- `IllegalArgumentException` - if the attribute is a multi-valued (rather than single-valued).
```

--------------------------------

### TstAbstractConnector: init

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/spi/class-use/Configuration.html

Initializes the TstAbstractConnector with a given configuration.

```APIDOC
## TstAbstractConnector.init

### Description
Initializes the TstAbstractConnector with a given configuration.

### Method
`void`

### Endpoint
N/A (Method within a class)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (void)
This method does not return a value.

#### Response Example
None
```

--------------------------------

### Connector Lifecycle and Configuration

Source: http://connid.tirasa.net/apidocs/1.6/net/tirasa/connid/commons/scripted/AbstractScriptedConnector.html

Details on initializing, disposing, and accessing the configuration of the connector.

```APIDOC
## Connector Lifecycle and Configuration

### Description
This section covers the lifecycle management of the connector, including initialization, disposal, and configuration retrieval.

### Methods

#### `init`

##### Description
Initializes the connector with the provided configuration.

##### Method
POST

##### Endpoint
`/api/connector/init`

##### Parameters

###### Request Body
- **cfg** (Configuration) - Required - The configuration object for the connector.

### Methods

#### `dispose`

##### Description
Disposes of any resources used by the connector.

##### Method
DELETE

##### Endpoint
`/api/connector/dispose`

### Methods

#### `getConfiguration`

##### Description
Retrieves the configuration object associated with the connector.

##### Method
GET

##### Endpoint
`/api/connector/configuration`

##### Response

###### Success Response (200)
- **config** (C) - The connector's configuration object.

###### Response Example
```json
{
  "config": { ... configuration details ... }
}
```
```

--------------------------------

### Get Boolean Value

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/common/objects/AttributeUtil.html

Retrieves the boolean value from a single-valued attribute.

```APIDOC
## getBooleanValue

### Description
Get the boolean value from the specified (single-valued) attribute.

### Method
`public static Boolean getBooleanValue(Attribute attr)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **Boolean** - null if the value is null otherwise the boolean value for the attribute.

#### Response Example
None

### Throws
- `ClassCastException` - if the object in the attribute is not an `Boolean`.
- `IllegalArgumentException` - if the attribute is a multi-valued (rather than single-valued).
```

--------------------------------

### Attribute Management Methods

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/common/objects/AttributeBuilder.html

Methods for getting and setting attribute properties.

```APIDOC
## Attribute Management Methods

### Description
Methods for retrieving and modifying the properties of an attribute during its construction.

### Method
`public String getName()`

### Endpoint
N/A (Instance Method)

### Description
Get the name of the attribute that is being built.

### Returns
* The name of the attribute.

---

### Method
`public AttributeBuilder setName(String name)`

### Endpoint
N/A (Instance Method)

### Description
Set the name of the attribute that is being built.

### Parameters
* **name** (String) - Required - The name to set for the attribute.

### Throws
* `IllegalArgumentException` - if the name parameter is blank.

### Returns
* The current `AttributeBuilder` instance for fluent chaining.

---

### Method
`public List<Object> getValue()`

### Endpoint
N/A (Instance Method)

### Description
Return any current value of the attribute that is being built.

### Returns
* A `List<Object>` containing the current values of the attribute.

---

### Method
`public AttributeBuilder addValue(Object... objs)`

### Endpoint
N/A (Instance Method)

### Description
Add each of the specified objects as values for the attribute that is being built.

### Parameters
* **objs** (Object...) - Required - The values to add to the attribute.

### Throws
* `NullPointerException` - if any of the values is null.

### Returns
* The current `AttributeBuilder` instance for fluent chaining.

---

### Method
`public AttributeBuilder addValue(Collection<?> obj)`

### Endpoint
N/A (Instance Method)

### Description
Adds each object in the collection as a value for the attribute that is being built.

### Parameters
* **obj** (Collection<?>) - Required - The collection of values to add to the attribute.

### Throws
* `NullPointerException` - if any of the values in the collection is null.

### Returns
* The current `AttributeBuilder` instance for fluent chaining.

---

### Method
`public AttributeValueCompleteness getAttributeValueCompleteness()`

### Endpoint
N/A (Instance Method)

### Description
Gets the completeness status of the attribute's value.

### Returns
* An `AttributeValueCompleteness` object.

---

### Method
`public void setAttributeValueCompleteness(AttributeValueCompleteness attributeValueCompleteness)`

### Endpoint
N/A (Instance Method)

### Description
Sets the completeness status for the attribute's value.

### Parameters
* **attributeValueCompleteness** (AttributeValueCompleteness) - Required - The completeness status to set.

### Request Example
```java
AttributeBuilder builder = new AttributeBuilder();
builder.setName("status");
builder.setAttributeValueCompleteness(AttributeValueCompleteness.COMPLETE);
Attribute attribute = builder.build();
```

### Response
None (void method)
```

--------------------------------

### Configuration Properties Impl Methods

Source: http://connid.tirasa.net/apidocs/1.6/index-all.html

Implementation-specific methods for configuration properties.

```APIDOC
## GET /websites/connid_tirasa_net/getProperties

### Description
Retrieves the properties associated with the configuration.

### Method
GET

### Endpoint
/websites/connid_tirasa_net/getProperties
```

--------------------------------

### createStartsWithExpression

Source: http://connid.tirasa.net/apidocs/1.6/net/tirasa/connid/commons/db/DatabaseFilterTranslator.html

Should be overridden by subclasses to create a STARTS-WITH expression if the native resource supports STARTS-WITH.

```APIDOC
## createStartsWithExpression

### Description
Should be overridden by subclasses to create a STARTS-WITH expression if the native resource supports STARTS-WITH.

### Method
protected

### Parameters
#### Path Parameters
- **filter** (StartsWithFilter) - Required - The contains filter. Will never be null.
- **not** (boolean) - Required - True if this should be a NOT STARTS-WITH

### Returns
The STARTS-WITH expression. A return value of null means a native STARTS-WITH query cannot be created for the given filter. In this case, `AbstractFilterTranslator.translate(org.identityconnectors.framework.common.objects.filter.Filter)` may return an empty query set, meaning fetch **everything**. The filter will be re-applied in memory to the resulting object stream. This does not scale well, so if possible, you should implement this method.
```

--------------------------------

### Get BigInteger Value

Source: http://connid.tirasa.net/apidocs/1.6/org/identityconnectors/framework/common/objects/AttributeUtil.html

Retrieves the BigInteger value from a single-valued attribute.

```APIDOC
## getBigIntegerValue

### Description
Get the big integer value from the specified (single-valued) attribute.

### Method
`public static BigInteger getBigIntegerValue(Attribute attr)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **BigInteger** - null if the value is null otherwise the big integer value for the attribute.

#### Response Example
None

### Throws
- `ClassCastException` - if the object in the attribute is not a big integer.
- `IllegalArgumentException` - if the attribute is a multi-valued (rather than single-valued).
```