com.microsoft.azure.storage.BaseEvent Maven / Gradle / Ivy

/**
 * Copyright Microsoft Corporation
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.microsoft.azure.storage;

/**
 * Represents an event.
 */
public abstract class BaseEvent {
    /**
     * Represents a connection object. Currently only java.net.HttpURLConnection is supported as a
     * connection object.
     */
    private final Object connectionObject;

    /**
     * Represents a context for the current operation. This object is used to track requests to the storage service, and
     * to provide additional runtime information about the operation.
     */
    private final OperationContext opContext;

    /**
     * A {@link RequestResult} object that represents the current request result.
     */
    private final RequestResult requestResult;

    /**
     * Creates an instance of the BaseEvent class.
     * 
     * @param opContext
     *            An {@link OperationContext} object that represents the context for the current operation. This object
     *            is used to track requests to the storage service, and to provide additional runtime information about
     *            the operation.
     * @param connectionObject
     *            Represents a connection object. Currently only java.net.HttpURLConnection is supported as
     *            a connection object.
     * @param requestResult
     *            A {@link RequestResult} object that represents the current request result.
     */
    public BaseEvent(final OperationContext opContext, final Object connectionObject, final RequestResult requestResult) {
        this.opContext = opContext;
        this.connectionObject = connectionObject;
        this.requestResult = requestResult;
    }

    /**
     * Gets a connection object. Currently only java.net.HttpURLConnection is supported as a
     * connection object.
     * 
     * @return An Object for the connection.
     */
    public Object getConnectionObject() {
        return this.connectionObject;
    }

    /**
     * Gets a context for the current operation. This object is used to track requests to the storage service, and
     * to provide additional runtime information about the operation.
     * 
     * @return The {@link OperationContext} for the current operation.
     */
    public OperationContext getOpContext() {
        return this.opContext;
    }

    /**
     * Gets a {@link RequestResult} object that represents the current request result.
     * 
     * @return The {@link RequestResult} object for the current request result.
     */
    public RequestResult getRequestResult() {
        return this.requestResult;
    }
}