Package org.forgerock.openam.rest

Class RestHttpRouteProvider

java.lang.Object

org.forgerock.openam.rest.RestHttpRouteProvider

All Implemented Interfaces:

jakarta.inject.Provider<Set<HttpRoute>>, HttpRouteProvider

public class RestHttpRouteProvider
extends Object
implements HttpRouteProvider

HTTP route provider for the REST (/json) endpoints. To add new REST endpoints the RestRouteProvider interface must be implemented and an entry into the Service loader file created.

Since:

13.0.0

Constructor Summary

Constructors

Constructor	Description
RestHttpRouteProvider()

Method Summary

Modifier and Type	Method	Description
Set<HttpRoute>	get()	Gets the HTTP routes that should be registered on the root HTTP Router.
void	setInjector(com.google.inject.Injector injector)
void	setInternalResourceRouter(ResourceRouter internalResourceRouter)
void	setRealmResourceRouter(ResourceRouter realmRouter)
void	setRealmServiceRouter(ServiceRouter realmRouter)
void	setRootResourceRouter(ResourceRouter rootRouter)
void	setRootServiceRouter(ServiceRouter rootRouter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RestHttpRouteProvider

public RestHttpRouteProvider()

Method Detail

get

public Set<HttpRoute> get()

Description copied from interface: HttpRouteProvider

Gets the HTTP routes that should be registered on the root HTTP Router.

Specified by:

get in interface HttpRouteProvider

Specified by:

get in interface jakarta.inject.Provider<Set<HttpRoute>>

Returns:

The root HTTP routes.

setRootResourceRouter

@Inject
public void setRootResourceRouter(@Named("RootResourceRouter")
                                  ResourceRouter rootRouter)

setRealmResourceRouter

@Inject
public void setRealmResourceRouter(@Named("RealmResourceRouter")
                                   ResourceRouter realmRouter)

setRootServiceRouter

@Inject
public void setRootServiceRouter(@Named("RootServiceRouter")
                                 ServiceRouter rootRouter)

setRealmServiceRouter

@Inject
public void setRealmServiceRouter(@Named("RealmServiceRouter")
                                  ServiceRouter realmRouter)

setInternalResourceRouter

@Inject
public void setInternalResourceRouter(@Named("InternalResourceRouter")
                                      ResourceRouter internalResourceRouter)

setInjector

@Inject
public void setInjector(com.google.inject.Injector injector)