Package org.forgerock.opendj.server.config.meta

Class SmtpAccountStatusNotificationHandlerCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<SmtpAccountStatusNotificationHandlerCfgClient,SmtpAccountStatusNotificationHandlerCfg>

org.forgerock.opendj.server.config.meta.SmtpAccountStatusNotificationHandlerCfgDefn

public final class SmtpAccountStatusNotificationHandlerCfgDefn
extends ManagedObjectDefinition<SmtpAccountStatusNotificationHandlerCfgClient,SmtpAccountStatusNotificationHandlerCfg>

An interface for querying the SMTP Account Status Notification Handler managed object definition meta information.

The SMTP Account Status Notification Handler is a notification handler that sends email messages to end users and/or administrators whenever an account status notification is generated.

Method Summary

Modifier and Type	Method	Description
SmtpAccountStatusNotificationHandlerCfgClient	createClientConfiguration(ManagedObject<? extends SmtpAccountStatusNotificationHandlerCfgClient> impl)	Creates a client configuration view of the provided managed object.
SmtpAccountStatusNotificationHandlerCfg	createServerConfiguration(ServerManagedObject<? extends SmtpAccountStatusNotificationHandlerCfg> impl)	Creates a server configuration view of the provided server managed object.
AttributeTypePropertyDefinition	getEmailAddressAttributeTypePropertyDefinition()	Get the "email-address-attribute-type" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static SmtpAccountStatusNotificationHandlerCfgDefn	getInstance()	Get the SMTP Account Status Notification Handler configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
StringPropertyDefinition	getMessageSubjectPropertyDefinition()	Get the "message-subject" property definition.
StringPropertyDefinition	getMessageTemplateFilePropertyDefinition()	Get the "message-template-file" property definition.
StringPropertyDefinition	getRecipientAddressPropertyDefinition()	Get the "recipient-address" property definition.
BooleanPropertyDefinition	getSendEmailAsHtmlPropertyDefinition()	Get the "send-email-as-html" property definition.
StringPropertyDefinition	getSenderAddressPropertyDefinition()	Get the "sender-address" property definition.
BooleanPropertyDefinition	getSendMessageWithoutEndUserAddressPropertyDefinition()	Get the "send-message-without-end-user-address" property definition.
Class<SmtpAccountStatusNotificationHandlerCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static SmtpAccountStatusNotificationHandlerCfgDefn getInstance()

Get the SMTP Account Status Notification Handler configuration definition singleton.

Returns:

Returns the SMTP Account Status Notification Handler configuration definition singleton.

createClientConfiguration

public SmtpAccountStatusNotificationHandlerCfgClient createClientConfiguration(ManagedObject<? extends SmtpAccountStatusNotificationHandlerCfgClient> impl)

Description copied from class: ManagedObjectDefinition

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<SmtpAccountStatusNotificationHandlerCfgClient,SmtpAccountStatusNotificationHandlerCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public SmtpAccountStatusNotificationHandlerCfg createServerConfiguration(ServerManagedObject<? extends SmtpAccountStatusNotificationHandlerCfg> impl)

Description copied from class: ManagedObjectDefinition

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<SmtpAccountStatusNotificationHandlerCfgClient,SmtpAccountStatusNotificationHandlerCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<SmtpAccountStatusNotificationHandlerCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<SmtpAccountStatusNotificationHandlerCfgClient,SmtpAccountStatusNotificationHandlerCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getEmailAddressAttributeTypePropertyDefinition

public AttributeTypePropertyDefinition getEmailAddressAttributeTypePropertyDefinition()

Get the "email-address-attribute-type" property definition.

Specifies which attribute in the user's entries may be used to obtain the email address when notifying the end user.

You can specify more than one email address as separate values. In this case, the OpenDJ server sends a notification to all email addresses identified.

Returns:

Returns the "email-address-attribute-type" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the SMTP Account Status Notification Handler is enabled. Only enabled handlers are invoked whenever a related event occurs in the server.

Returns:

Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

Specifies the fully-qualified name of the Java class that provides the SMTP Account Status Notification Handler implementation.

Returns:

Returns the "java-class" property definition.

getMessageSubjectPropertyDefinition

public StringPropertyDefinition getMessageSubjectPropertyDefinition()

Get the "message-subject" property definition.

Specifies the subject that should be used for email messages generated by this account status notification handler.

The values for this property should begin with the name of an account status notification type followed by a colon and the subject that should be used for the associated notification message. If an email message is generated for an account status notification type for which no subject is defined, then that message is given a generic subject.

Returns:

Returns the "message-subject" property definition.

getMessageTemplateFilePropertyDefinition

public StringPropertyDefinition getMessageTemplateFilePropertyDefinition()

Get the "message-template-file" property definition.

Specifies the path to the file containing the message template to generate the email notification messages.

The values for this property should begin with the name of an account status notification type followed by a colon and the path to the template file that should be used for that notification type. If an account status notification has a notification type that is not associated with a message template file, then no email message is generated for that notification.

Returns:

Returns the "message-template-file" property definition.

getRecipientAddressPropertyDefinition

public StringPropertyDefinition getRecipientAddressPropertyDefinition()

Get the "recipient-address" property definition.

Specifies an email address to which notification messages are sent, either instead of or in addition to the end user for whom the notification has been generated.

This may be used to ensure that server administrators also receive a copy of any notification messages that are generated.

Returns:

Returns the "recipient-address" property definition.

getSendEmailAsHtmlPropertyDefinition

public BooleanPropertyDefinition getSendEmailAsHtmlPropertyDefinition()

Get the "send-email-as-html" property definition.

Indicates whether an email notification message should be sent as HTML.

If this value is true, email notification messages are marked as text/html. Otherwise outgoing email messages are assumed to be plaintext and marked as text/plain.

Returns:

Returns the "send-email-as-html" property definition.

getSenderAddressPropertyDefinition

public StringPropertyDefinition getSenderAddressPropertyDefinition()

Get the "sender-address" property definition.

Specifies the email address from which the message is sent. Note that this does not necessarily have to be a legitimate email address.

Returns:

Returns the "sender-address" property definition.

getSendMessageWithoutEndUserAddressPropertyDefinition

public BooleanPropertyDefinition getSendMessageWithoutEndUserAddressPropertyDefinition()

Get the "send-message-without-end-user-address" property definition.

Indicates whether an email notification message should be generated and sent to the set of notification recipients even if the user entry does not contain any values for any of the email address attributes (that is, in cases when it is not be possible to notify the end user).

This is only applicable if both one or more email address attribute types and one or more additional recipient addresses are specified.

Returns:

Returns the "send-message-without-end-user-address" property definition.