Package org.forgerock.openig.heap

Interface Heaplet

All Known Implementing Classes:

AbstractScriptableHeapObject.AbstractScriptableHeaplet, AllowOnlyFilter.Heaplet, AmServiceHeaplet, AmSessionIdleTimeoutFilter.Heaplet, AssignmentFilter.Heaplet, AuditServiceObjectHeaplet, Base64EncodedSecretStore.Heaplet, BaseUriDecorator.Heaplet, CaffeineCacheAccessTokenResolver.Heaplet, CaptureDecorator.Heaplet, CapturedUserPasswordFilter.Heaplet, CertificateThumbprintFilter.Heaplet, ChainFilterHeaplet, ChainHandlerHeaplet, CircuitBreakerFilter.Heaplet, ClientCredentialsOAuth2ClientFilterHeaplet, ClientHandlerHeaplet, ClientRegistration.Heaplet, ClientSecretBasicAuthenticationFilterHeaplet, ClientSecretPostAuthenticationFilterHeaplet, ClientTlsOptionsHeaplet, ConditionalFilterHeaplet, ConditionEnforcementFilter.Heaplet, ConfirmationKeyVerifierAccessTokenResolver.Heaplet, CookieFilter.Heaplet, CorsFilterHeaplet, CrossDomainSingleSignOnFilter.Heaplet, CryptoHeaderFilter.Heaplet, CsrfFilterHeaplet, CustomProxyOptions.Heaplet, DateHeaderFilter.Heaplet, DecoratorHeaplet, DefaultRateThrottlingPolicyHeaplet, DelegateHeaplet, DesKeyGenHandler.Heaplet, DispatchHandler.Heaplet, EncryptedPrivateKeyJwtClientAuthenticationFilterHeaplet, EntityExtractFilter.Heaplet, FapiInteractionIdFilter.Heaplet, FileAttributesFilter.Heaplet, FileSystemSecretStoreHeaplet, ForwardedRequestFilter.Heaplet, FragmentFilter.Heaplet, GenericHeaplet, HeaderFilter.Heaplet, HsmSecretStoreHeaplet, HttpBasicAuthenticationClientFilterHeaplet, HttpBasicAuthFilter.Heaplet, HttpClientHandlerHeaplet, IdTokenValidationFilterHeaplet, Issuer.Heaplet, IssuerRepository.Heaplet, JdbcDataSourceHeaplet, JwkSetHandler.Heaplet, JwkSetSecretStoreHeaplet, JwtBuilderFilter.Heaplet, JwtSessionManagerHeaplet, JwtValidationFilter.Heaplet, KeyManagerHeaplet, KeyStoreHeaplet, KeyStoreSecretStoreHeaplet, LocationHeaderFilter.Heaplet, MappedThrottlingPolicyHeaplet, NoOpAuditService.Heaplet, NoProxyOptions.Heaplet, OAuth2ClientFilter.Heaplet, OAuth2ResourceServerFilterHeaplet, OAuth2TokenExchangeFilter.Heaplet, OpenAmAccessTokenResolverHeaplet, PasswordReplayFilterHeaplet, PemPropertyFormatHeaplet, PolicyEnforcementFilter.Heaplet, PrivateKeyJwtClientAuthenticationFilterHeaplet, RequestResourceUriProvider.Heaplet, ResourceHandler.Heaplet, ResourceOwnerOAuth2ClientFilterHeaplet, ReverseProxyHandlerHeaplet, RouterHandler.Heaplet, SamlFederationHandler.Heaplet, ScheduledExecutorServiceHeaplet, ScriptableAccessTokenResolver.Heaplet, ScriptableFilter.Heaplet, ScriptableHandler.Heaplet, ScriptableJwtValidatorCustomizer.Heaplet, ScriptableResourceAccess.Heaplet, ScriptableResourceUriProvider.Heaplet, ScriptableThrottlingPolicy.Heaplet, SecretKeyPropertyFormatHeaplet, SecretsKeyManagerHeaplet, SecretsProviderHeaplet, SecretsTrustManagerHeaplet, SequenceHandler.Heaplet, ServerTlsOptionsHeaplet, SessionInfoFilter.Heaplet, SetCookieUpdateFilter.Heaplet, SingleSignOnFilter.Heaplet, SqlAttributesFilter.Heaplet, StatelessAccessTokenResolver.Heaplet, StaticRequestFilter.Heaplet, StaticResponseHandler.Heaplet, SwitchFilter.Heaplet, SystemAndEnvSecretStoreHeaplet, SystemProxyOptions.Heaplet, TemporaryStorageHeaplet, ThrottlingFilterHeaplet, TimerDecorator.Heaplet, TokenIntrospectionAccessTokenResolverHeaplet, TokenTransformationFilter.Heaplet, TrustAllManager.Heaplet, TrustManagerHeaplet, UmaResourceServerFilter.Heaplet, UmaSharingService.Heaplet, UriPathRewriteFilter.Heaplet, UserProfileFilterHeaplet, UserProfileServiceHeaplet, WelcomeHandler.Heaplet

public interface Heaplet

Creates and initializes an object that is stored in a Heap. A heaplet can retrieve object(s) it depends on from the heap.

Method Summary

Modifier and Type	Method	Description
Object	create(Name name, JsonValue config, Heap heap)	Called to request the heaplet to create an object.
void	destroy()	Called to indicate that the object created by the heaplet is going to be dereferenced.

Method Detail

create

Object create(Name name,
              JsonValue config,
              Heap heap)
       throws HeapException

Called to request the heaplet to create an object.

Parameters:

name - the name of the object to be created.

config - the heaplet's configuration object.

heap - the heap where object dependencies can be retrieved.

Returns:

the object created by the heaplet.

Throws:

HeapException - if an exception occurred during creation of the object or any of its dependencies.

JsonValueException - if the heaplet (or one of its dependencies) has a malformed configuration object.

destroy

void destroy()

Called to indicate that the object created by the heaplet is going to be dereferenced. This gives the heaplet an opportunity to free any resources that are being held prior to its dereference.