com.microsoft.rest.v2.policy

Class AbstractRequestPolicy

java.lang.Object

com.microsoft.rest.v2.policy.AbstractRequestPolicy

All Implemented Interfaces:

RequestPolicy

public abstract class AbstractRequestPolicy
extends Object
implements RequestPolicy

An abstract RequestPolicy base-class.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRequestPolicy(RequestPolicy nextPolicy, RequestPolicyOptions options) Initialize the fields for this AbstractRequestPolicy.

Method Summary

Modifier and Type	Method and Description
protected void	log(HttpPipelineLogLevel logLevel, String message, Object... formattedMessageArguments) Attempt to log the provided message to the provided logger.
protected RequestPolicy	nextPolicy() Get the next RequestPolicy in the policy chain.
protected RequestPolicyOptions	options() Get the options that were provided to this AbstractRequestPolicy.
boolean	shouldLog(HttpPipelineLogLevel logLevel) Get whether or not a log with the provided log level should be logged.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microsoft.rest.v2.policy.RequestPolicy

sendAsync

Constructor Detail

AbstractRequestPolicy

protected AbstractRequestPolicy(RequestPolicy nextPolicy,
                                RequestPolicyOptions options)

Initialize the fields for this AbstractRequestPolicy.

Parameters:

nextPolicy - The next RequestPolicy in the policy chain.

options - The options for this RequestPolicy.

Method Detail

nextPolicy

protected RequestPolicy nextPolicy()

Get the next RequestPolicy in the policy chain.

Returns:

The next RequestPolicy in the policy chain.

options

protected RequestPolicyOptions options()

Get the options that were provided to this AbstractRequestPolicy.

Returns:

The options that were provided to this AbstractRequestPolicy.

shouldLog

public boolean shouldLog(HttpPipelineLogLevel logLevel)

Get whether or not a log with the provided log level should be logged.

Parameters:

logLevel - The log level of the log that will be logged.

Returns:

Whether or not a log with the provided log level should be logged.

log

protected void log(HttpPipelineLogLevel logLevel,
                   String message,
                   Object... formattedMessageArguments)

Attempt to log the provided message to the provided logger. If no logger was provided or if the log level does not meat the logger's threshold, then nothing will be logged.

Parameters:

logLevel - The log level of this log.

message - The message of this log.

formattedMessageArguments - The formatted arguments to apply to the message.