/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at legal-notices/CDDLv1_0.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
* Portions Copyright 2014 ForgeRock AS
*/
/**
* This class defines the set of methods that must be implemented for
* an account status notification handler. This handler will be
* invoked whenever certain types of events occur that could change
* the status of a user account. The account status notification
* change.
*
* @param <T> The type of configuration handled by this notification
* handler.
*/
mayInstantiate=false,
mayExtend=true,
mayInvoke=false)
public abstract class
<T extends AccountStatusNotificationHandlerCfg>
{
/**
* Initializes this account status notification handler based on the
* information in the provided configuration entry.
*
* @param configuration The configuration entry that contains the
* information to use to initialize this
* account status notification handler.
*
* @throws ConfigException If the provided entry does not contain
* a valid configuration for this account
* status notification handler.
*
* @throws InitializationException If a problem occurs during
* initialization that is not
* related to the server
* configuration.
*/
public abstract void initializeStatusNotificationHandler(
throws ConfigException, InitializationException;
/**
* Indicates whether the provided configuration is acceptable for
* this account status notification handler. It should be possible
* to call this method on an uninitialized account status
* notification handler instance in order to determine whether the
* handler would be able to use the provided configuration.
* <BR><BR>
* Note that implementations which use a subclass of the provided
* configuration class will likely need to cast the configuration
* to the appropriate subclass type.
*
* @param configuration The account status notification
* handler configuration for which to
* make the determination.
* @param unacceptableReasons A list that may be used to hold the
* reasons that the provided
* configuration is not acceptable.
*
* @return {@code true} if the provided configuration is acceptable
* for this account status notification handler, or
* {@code false} if not.
*/
public boolean isConfigurationAcceptable(
{
// This default implementation does not perform any special
// validation. It should be overridden by account status
// notification implementations that wish to perform more detailed
// validation.
return true;
}
/**
* Performs any finalization that may be necessary when this status
* notification handler is taken out of service.
*/
public void finalizeStatusNotificationHandler()
{
// No action is required by default.
}
/**
* Performs any processing that may be necessary in conjunction with
* the provided account status notification.
*
* @param notification The account status notification to be
* processed.
*/
public abstract void handleStatusNotification(
}