001/**
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
005 *
006 * The contents of this file are subject to the terms
007 * of the Common Development and Distribution License
008 * (the License). You may not use this file except in
009 * compliance with the License.
010 *
011 * You can obtain a copy of the License at
012 * https://opensso.dev.java.net/public/CDDLv1.0.html or
013 * opensso/legal/CDDLv1.0.txt
014 * See the License for the specific language governing
015 * permission and limitations under the License.
016 *
017 * When distributing Covered Code, include this CDDL
018 * Header Notice in each file and include the License file
019 * at opensso/legal/CDDLv1.0.txt.
020 * If applicable, add the following below the CDDL Header,
021 * with the fields enclosed by brackets [] replaced by
022 * your own identifying information:
023 * "Portions Copyrighted [year] [name of copyright owner]"
024 *
025 * $Id: PolicyListener.java,v 1.2 2008/06/25 05:43:47 qcheng Exp $
026 *
027 * Portions Copyrighted 2014 ForgeRock AS.
028 */
029
030
031
032package com.sun.identity.policy.interfaces;
033import com.sun.identity.policy.PolicyEvent;
034
035/**
036 * The interface <code>PolicyListener</code> defines an interface 
037 * for listeners that would register with policy framework 
038 * to receive notifications whenever a <code>Policy</code> is added, removed 
039 * or changed
040 *
041 * @see 
042 * com.sun.identity.policy.PolicyEvaluator#addPolicyListener(PolicyListener)
043 * @supported.all.api
044 * @deprecated since 12.0.0
045 */
046@Deprecated
047public interface PolicyListener {
048
049    /**
050     * Returns the service type name for which this listener wants to get
051     * notifications
052     *
053     * @return String representing the service type name.
054     */
055     public String getServiceTypeName(); 
056
057    /** This method is called by the policy framework whenever 
058     *  a policy is added, removed or changed. The notification
059     *  is sent only if the policy has any rule that has the 
060     *  <code>serviceTypeName</code> of this listener
061     *
062     *  @param policyEvent event object sent by the policy framework
063     *  @see com.sun.identity.policy.PolicyEvent
064     */
065     public void policyChanged(PolicyEvent policyEvent);
066
067}