a4544a5a0e622ef69e38641f87ab1b5685e05911Phill Cunnington/*
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Copyright (c) 2009 Sun Microsystems Inc. All Rights Reserved
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * The contents of this file are subject to the terms
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * of the Common Development and Distribution License
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * (the License). You may not use this file except in
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * compliance with the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * You can obtain a copy of the License at
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * opensso/legal/CDDLv1.0.txt
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * See the License for the specific language governing
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * permission and limitations under the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * When distributing Covered Code, include this CDDL
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Header Notice in each file and include the License file
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * at opensso/legal/CDDLv1.0.txt.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * If applicable, add the following below the CDDL Header,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * with the fields enclosed by brackets [] replaced by
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * your own identifying information:
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * $Id: ListenerManager.java,v 1.3 2010/01/07 00:19:11 veiming Exp $
402cd5da45d9182b81c16a13c3568faf78701827Andrew Forrest *
a4544a5a0e622ef69e38641f87ab1b5685e05911Phill Cunnington * Portions Copyrighted 2015 ForgeRock AS.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterpackage com.sun.identity.entitlement;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterimport com.sun.identity.entitlement.interfaces.IEntitlementListenerRegistry;
402cd5da45d9182b81c16a13c3568faf78701827Andrew Forrestimport org.forgerock.openam.entitlement.PolicyConstants;
402cd5da45d9182b81c16a13c3568faf78701827Andrew Forrest
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterimport java.net.MalformedURLException;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterimport java.net.URL;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterimport java.util.Collections;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterimport java.util.Set;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterimport javax.security.auth.Subject;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster/**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Listener manager manages registering and de-registering of listener.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterpublic final class ListenerManager {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster private static final ListenerManager instance = new ListenerManager();
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster private static IEntitlementListenerRegistry registry;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster static {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster //RFE: make it pluggable
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster try {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster Class clazz = Class.forName(
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster "com.sun.identity.entitlement.opensso.OpenSSOEntitlementListener");
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster registry = (IEntitlementListenerRegistry)clazz.newInstance();
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster } catch (InstantiationException ex) {
402cd5da45d9182b81c16a13c3568faf78701827Andrew Forrest PolicyConstants.DEBUG.error("ListenerManager.<init>", ex);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster } catch (IllegalAccessException ex) {
402cd5da45d9182b81c16a13c3568faf78701827Andrew Forrest PolicyConstants.DEBUG.error("ListenerManager.<init>", ex);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster } catch (ClassNotFoundException ex) {
402cd5da45d9182b81c16a13c3568faf78701827Andrew Forrest PolicyConstants.DEBUG.error("ListenerManager.<init>", ex);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster private ListenerManager() {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public static ListenerManager getInstance() {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster return instance;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster /**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Adds entitlement listener.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param adminSubject administrator subject.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param listener entitlement listener.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws EntitlementException if listener cannot be added.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public void addListener(Subject adminSubject, EntitlementListener listener)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster throws EntitlementException {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster if (registry != null) {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster registry.addListener(adminSubject, listener);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster /**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns registered listener of the notification URL.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param adminSubject administrator subject.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param url Notification URL.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return registered listener.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws EntitlementException if listener cannot be retrieved.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public EntitlementListener getListener(
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster Subject adminSubject,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster String url)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster throws EntitlementException {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster if (url == null) {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster throw new EntitlementException(436);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster try {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster URL urlObj = new URL(url);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster Set<EntitlementListener> listeners = getListeners(adminSubject);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster for (EntitlementListener l : listeners) {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster if (l.getUrl().equals(urlObj)) {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster return l;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster return null;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster } catch (MalformedURLException e) {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster throw new EntitlementException(435);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster /**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns a set of registered listeners.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param adminSubject administrator subject.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return a set of registered listeners.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws EntitlementException if listeners cannot be retrieved.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public Set<EntitlementListener> getListeners(Subject adminSubject)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster throws EntitlementException {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster return (registry != null) ?
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster registry.getListeners(adminSubject) : Collections.EMPTY_SET;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster /**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns <code>true</code> if listener(s) is/are successfully removed.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param adminSubject administrator subject.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param url Notification URL.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return <code>true</code> if listener(s) is/are successfully removed.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws EntitlementException if listener(s) cannot be removed.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public boolean removeListener(Subject adminSubject, String url)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster throws EntitlementException {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster if (registry != null) {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster return registry.removeListener(adminSubject, url);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster return false;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster }
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster}