Note: this is an abstract component, that cannot be instantiated.
End Points are used to define a web service end point that will be used to handle HTTP-based client requests using RESTful APIs.
Web Service end point is the way to expose directory services using RESTful APIs.
The following End Points are available in the server :
These End Points inherit from the properties described below.
The following components have a direct AGGREGATION relation TO End Points :
A description of each property follows.
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ context-path | None |
| ↓ enabled | |
| ↓ java-class |
| Description | The context path of the end point. Define the context path of the end point. |
|---|---|
| Default Value | None |
| Allowed Values | A String |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Indicates whether the End Point is enabled. |
|---|---|
| Default Value | None |
| Allowed Values | true false |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Specifies the fully-qualified name of the Java class that provides the End Point implementation. |
|---|---|
| Default Value | None |
| Allowed Values | A java class that implements or extends the class(es) : org.opends.server.api.HTTPEndPoint |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | The End Point must be disabled and re-enabled for changes to this setting to take effect |
| Advanced Property | No |
| Read-only | No |