Package com.unboundid.directory.sdk.broker.types

Interface BrokerContext

All Superinterfaces:

ServerContext

@NotExtensible
@ThreadSafety(level=INTERFACE_THREADSAFE)
public interface BrokerContext
extends ServerContext

This interface may be used to obtain information about the PingAuthorize Server in which an extension is running.

Method Summary

Modifier and Type	Method	Description
boolean	isTraceMessageLoggable()	Deprecated. See the trace log-related methods in ServerContext.
void	logTraceMessage(java.lang.String message)	Deprecated. See the trace log-related methods in ServerContext.
void	logTraceMessage(java.lang.String message, java.util.Map<java.lang.String,java.lang.String> keyValues)	Deprecated. See the trace log-related methods in ServerContext.

Methods inherited from interface com.unboundid.directory.sdk.common.types.ServerContext

createEMailAttachment, createEMailMessage, createThread, createValueConstructor, debugCaught, debugEnabled, debugError, debugInfo, debugThrown, debugVerbose, debugWarning, deregisterAllMonitorProviders, deregisterChangeListener, deregisterDiskSpaceConsumer, deregisterMonitorProvider, deregisterShutdownListener, deregisterSupportedControlOID, getBasicProductName, getClientConnection, getClientRootConnection, getCompactProductName, getEncryptedOutputStream, getEncryptedOutputStream, getEncryptionSettingsDefinition, getEncryptionSettingsDefinitions, getFullProductName, getFullVendorName, getFullVersion, getGroup, getGroupsForUser, getInstanceName, getInternalConnection, getInternalRootConnection, getLDAPExternalServerConnection, getLDAPExternalServerConnectionPool, getLocation, getMajorVersionNumber, getMinorVersionNumber, getObscuredValue, getPackageName, getPassphraseFromPassphraseProvider, getPatchVersionNumber, getPointVersionNumber, getPossiblyCompressedAndEncryptedInputStream, getPossiblyCompressedAndEncryptedInputStream, getPreferredEncryptionSettingsDefinition, getPrivilegeNames, getSchema, getServerRoot, getShortVendorName, getSourceRevision, getStartTime, getStartupID, getStartupUUID, getToolExecutor, getVersionNumber, getVersionQualifier, hasPrivilege, isDirectoryFunctionalityAvailable, isDirectoryProxyFunctionalityAvailable, isRunning, isShuttingDown, isStarting, isSyncFunctionalityAvailable, isTraceMessageLoggable, logMessage, logTraceMessage, logTraceMessage, registerChangeListener, registerDiskSpaceConsumer, registerMonitorProvider, registerShutdownListener, registerSupportedControlOID, reloadHTTPConnectionHandlerCertificates, sendAlert, sendAlert, sendDegradedAlertNotification, sendUnavailableAlertNotification

Method Detail

isTraceMessageLoggable

@Deprecated
boolean isTraceMessageLoggable()

Deprecated.

See the trace log-related methods in ServerContext.

Indicates whether trace log messages from extensions are loggable to any trace log publishers. This allows callers to avoid expensive message construction for messages that are not going to be logged.

Returns:

true if trace log messages from extensions are loggable to any trace log publishers

logTraceMessage

@Deprecated
void logTraceMessage(java.lang.String message)

Deprecated.

See the trace log-related methods in ServerContext.

Writes a message to the server trace log publishers. Sensitive information must not be included in the contents of the message.

Trace log messages should be used in methods that are called when processing an incoming request. The trace log will automatically include request identifiers in the log messages so that all log messages about a request can be correlated.

You can use the search-logs command-line tool on the trace log file to extract only the messages logged by your extension.

Parameters:

message - The message to be logged. It must not be null.

logTraceMessage

@Deprecated
void logTraceMessage(java.lang.String message,
                     java.util.Map<java.lang.String,java.lang.String> keyValues)

Deprecated.

See the trace log-related methods in ServerContext.

Writes a message to the server trace log publishers, including key value pairs to be logged with the message. Sensitive information must not be included in the contents of the message or the key value pairs.

Trace log messages should be used in methods that are called when processing an incoming request. The trace log will automatically include request identifiers in the log messages so that all log messages about a request can be correlated.

You can use the search-logs command-line tool on the trace log file to extract only the messages logged by your extension.

Parameters:

message - The message to be logged. It must not be null.

keyValues - Keys and values that are to be logged with key=value. It may be null.