EndpointRegistry (IG Aggregated Javadoc 2023.11.1 Documentation)

java.lang.Object
- org.forgerock.openig.http.EndpointRegistry

```
public final class EndpointRegistry
extends Object
```
Registry for Identity Gateway REST API endpoints.
Components can use that class to register additional endpoints into the /openig/api namespace:
- /openig/api/system/objects/[heap-object-name] for components defined in config.json
- /openig/api/system/objects/.../[router-name]/routes/[route-name]/objects/[heap-object-name] for components defined inside routes
See Also:

GenericHeaplet.endpointRegistry()

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class EndpointRegistry.Registration
Handle for un-registering an endpoint.

Constructor Summary

Constructors
Constructor Description

EndpointRegistry(Router router, String path)
Creates a registry around the given Router instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getPath()`	Returns this registry's base path.
`String`	`pathInfo(String name)`	Returns the path info computed by appending the given `name` to this registry's path.
`EndpointRegistry.Registration`	`register(String name, Handler handler)`	Registers a new endpoint under the given `name`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EndpointRegistry
```
public EndpointRegistry(Router router,
                        String path)
```
    Creates a registry around the given Router instance. Registered endpoints will be sub-elements of the given router.
    
    Parameters:
    
    router - base Router
    
    path - path for this registry
- Method Detail
  - register
```
public EndpointRegistry.Registration register(String name,
                                              Handler handler)
```
    Registers a new endpoint under the given name.
    Equivalent to calling this Router code:
    router.addRoute(requestUriMatcher(STARTS_WITH, name), handler);
    Parameters:
    
    name - registered endpoint name
    
    handler - endpoint implementation
    
    Returns:
    
    a handle for later endpoint un-registration
  - pathInfo
```
public String pathInfo(String name)
```
    Returns the path info computed by appending the given name to this registry's path.
    
    Parameters:
    
    name - path element to append
    
    Returns:
    
    composed path
  - getPath
```
public String getPath()
```
    Returns this registry's base path.
    
    Returns:
    
    this registry's base path.