xref: /frameworks/base/drm/java/android/drm/DrmEvent.java

/*
 * Copyright (C) 2010 The Android Open Source Project
 *
 * 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 android.drm;

/**
 * This is the base class which would be used to notify the caller
 * about any event occurred in DRM framework.
 *
 */
public class DrmEvent {
    /**
     * Constant field signifies that unload and finalize the loaded plugins successfully
     */
    public static final int TYPE_FINALIZED = 1001;
    /**
     * Constant field signifies that register with the service successfully
     */
    public static final int TYPE_REGISTERED = 1002;
    /**
     * Constant field signifies that load and initialized the available plugins successfully
     */
    public static final int TYPE_INITIALIZED = 1003;
    /**
     * Constant field signifies that unregister with the service successfully
     */
    public static final int TYPE_UNREGISTERED = 1004;
    /**
     * Constant field signifies that rights information is acquired successfully
     */
    public static final int TYPE_RIGHTS_ACQUIRED = 1005;
    /**
     * Constant field signifies that all the rights information associated with
     * all DRM schemes are removed successfully
     */
    public static final int TYPE_ALL_RIGHTS_REMOVED = 1006;
    /**
     * Constant field signifies that the required information to communicate with
     * the service is acquired sucessfully
     */
    public static final int TYPE_DRM_INFO_ACQUIRED = 1007;

    public static final String DRM_INFO_STATUS_OBJECT = "drm_info_status_object";
    public static final String DRM_INFO_OBJECT = "drm_info_object";

    private final int mUniqueId;
    private final int mType;
    private String mMessage = "";

    /**
     * constructor for DrmEvent class
     *
     * @param uniqueId Unique session identifier
     * @param type Type of information
     * @param message Message description
     */
    protected DrmEvent(int uniqueId, int type, String message) {
        mUniqueId = uniqueId;
        mType = type;

        if (null != message) {
            mMessage = message;
        }
    }

    /**
     * Returns the Unique Id associated with this object
     *
     * @return Unique Id
     */
    public int getUniqueId() {
        return mUniqueId;
    }

    /**
     * Returns the Type of information associated with this object
     *
     * @return Type of information
     */
    public int getType() {
        return mType;
    }

    /**
     * Returns the message description associated with this object
     *
     * @return message description
     */
    public String getMessage() {
        return mMessage;
    }
}