001: /******************************************************************************
002: * JBoss, a division of Red Hat *
003: * Copyright 2006, Red Hat Middleware, LLC, and individual *
004: * contributors as indicated by the @authors tag. See the *
005: * copyright.txt in the distribution for a full listing of *
006: * individual contributors. *
007: * *
008: * This is free software; you can redistribute it and/or modify it *
009: * under the terms of the GNU Lesser General Public License as *
010: * published by the Free Software Foundation; either version 2.1 of *
011: * the License, or (at your option) any later version. *
012: * *
013: * This software is distributed in the hope that it will be useful, *
014: * but WITHOUT ANY WARRANTY; without even the implied warranty of *
015: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
016: * Lesser General Public License for more details. *
017: * *
018: * You should have received a copy of the GNU Lesser General Public *
019: * License along with this software; if not, write to the Free *
020: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
021: * 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
022: ******************************************************************************/package org.jboss.portal.registration;
023:
024: import javax.xml.namespace.QName;
025: import java.util.Map;
026:
027: /**
028: * A class representing an association between a consumer and a producer.
029: *
030: * @author <a href="mailto:chris.laprun@jboss.com">Chris Laprun</a>
031: * @author <a href="mailto:julien@jboss.org">Julien Viet</a>
032: * @version $Revision: 8784 $
033: * @since 2.6
034: */
035: public interface Registration {
036: /**
037: * Retrieves the internal identifier for this Registration. This will correspond to the database key for this
038: * Registration. This identifier can be used by {@link RegistrationPolicy} to create a handle for this Registration.
039: *
040: * @return this Registration's internal identifier.
041: */
042: String getId();
043:
044: /**
045: * Sets the handle for this Registration.
046: *
047: * @param handle
048: */
049: void setRegistrationHandle(String handle);
050:
051: /**
052: * Retrieves the handle associated with this Registration
053: *
054: * @return the registration handle
055: */
056: String getRegistrationHandle();
057:
058: /**
059: * Return the consumer owning this registration.
060: *
061: * @return the owning consumer
062: */
063: Consumer getConsumer();
064:
065: /**
066: * Retrieve the properties associated with this Registration.
067: *
068: * @return a Map containing the associated properties
069: */
070: Map getProperties();
071:
072: void setPropertyValueFor(QName propertyName, Object value)
073: throws IllegalArgumentException;
074:
075: void setPropertyValueFor(String propertyName, Object value);
076:
077: boolean hasEqualProperties(Registration registration);
078:
079: boolean hasEqualProperties(Map properties);
080:
081: /**
082: * Return the status of this specific registration.
083: *
084: * @return the status
085: */
086: RegistrationStatus getStatus();
087:
088: /**
089: * Update the registration status
090: *
091: * @param status the new status
092: */
093: void setStatus(RegistrationStatus status);
094:
095: /** Clears any state (cloned portlet information, session, etc) associated with this Registration */
096: void clearAssociatedState();
097:
098: void updateProperties(Map registrationProperties);
099:
100: void removeProperty(QName propertyName);
101:
102: void removeProperty(String propertyName);
103:
104: Object getPropertyValueFor(QName propertyName);
105:
106: Object getPropertyValueFor(String propertyName);
107: }
|