michael@0: /**
michael@0:  * Copyright (c) 2012, Ben Fortuna
michael@0:  * All rights reserved.
michael@0:  *
michael@0:  * Redistribution and use in source and binary forms, with or without
michael@0:  * modification, are permitted provided that the following conditions
michael@0:  * are met:
michael@0:  *
michael@0:  *  o Redistributions of source code must retain the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer.
michael@0:  *
michael@0:  *  o Redistributions in binary form must reproduce the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer in the
michael@0:  * documentation and/or other materials provided with the distribution.
michael@0:  *
michael@0:  *  o Neither the name of Ben Fortuna nor the names of any other contributors
michael@0:  * may be used to endorse or promote products derived from this software
michael@0:  * without specific prior written permission.
michael@0:  *
michael@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
michael@0:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0:  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0:  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0:  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0:  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0:  */
michael@0: package net.fortuna.ical4j.model.property;
michael@0: 
michael@0: import java.net.URI;
michael@0: import java.net.URISyntaxException;
michael@0: 
michael@0: import net.fortuna.ical4j.model.Parameter;
michael@0: import net.fortuna.ical4j.model.ParameterList;
michael@0: import net.fortuna.ical4j.model.Property;
michael@0: import net.fortuna.ical4j.model.PropertyFactoryImpl;
michael@0: import net.fortuna.ical4j.model.ValidationException;
michael@0: import net.fortuna.ical4j.util.ParameterValidator;
michael@0: import net.fortuna.ical4j.util.Strings;
michael@0: import net.fortuna.ical4j.util.Uris;
michael@0: 
michael@0: /**
michael@0:  * $Id$
michael@0:  * 
michael@0:  * Created: [Apr 6, 2004]
michael@0:  *
michael@0:  * Defines an ORGANIZER iCalendar component property.
michael@0:  * 
michael@0:  * <pre>
michael@0:  *     4.8.4.3 Organizer
michael@0:  *     
michael@0:  *        Property Name: ORGANIZER
michael@0:  *     
michael@0:  *        Purpose: The property defines the organizer for a calendar component.
michael@0:  *     
michael@0:  *        Value Type: CAL-ADDRESS
michael@0:  *     
michael@0:  *        Property Parameters: Non-standard, language, common name, directory
michael@0:  *        entry reference, sent by property parameters can be specified on this
michael@0:  *        property.
michael@0:  *     
michael@0:  *        Conformance: This property MUST be specified in an iCalendar object
michael@0:  *        that specifies a group scheduled calendar entity. This property MUST
michael@0:  *        be specified in an iCalendar object that specifies the publication of
michael@0:  *        a calendar user's busy time. This property MUST NOT be specified in
michael@0:  *        an iCalendar object that specifies only a time zone definition or
michael@0:  *        that defines calendar entities that are not group scheduled entities,
michael@0:  *        but are entities only on a single user's calendar.
michael@0:  *     
michael@0:  *        Description: The property is specified within the &quot;VEVENT&quot;, &quot;VTODO&quot;,
michael@0:  *        &quot;VJOURNAL calendar components to specify the organizer of a group
michael@0:  *        scheduled calendar entity. The property is specified within the
michael@0:  *        &quot;VFREEBUSY&quot; calendar component to specify the calendar user
michael@0:  *        requesting the free or busy time. When publishing a &quot;VFREEBUSY&quot;
michael@0:  *        calendar component, the property is used to specify the calendar that
michael@0:  *        the published busy time came from.
michael@0:  *     
michael@0:  *        The property has the property parameters CN, for specifying the
michael@0:  *        common or display name associated with the &quot;Organizer&quot;, DIR, for
michael@0:  *        specifying a pointer to the directory information associated with the
michael@0:  *        &quot;Organizer&quot;, SENT-BY, for specifying another calendar user that is
michael@0:  *        acting on behalf of the &quot;Organizer&quot;. The non-standard parameters may
michael@0:  *        also be specified on this property. If the LANGUAGE property
michael@0:  *        parameter is specified, the identified language applies to the CN
michael@0:  *        parameter value.
michael@0:  *     
michael@0:  *        Format Definition: The property is defined by the following notation:
michael@0:  *     
michael@0:  *          organizer  = &quot;ORGANIZER&quot; orgparam &quot;:&quot;
michael@0:  *                       cal-address CRLF
michael@0:  *     
michael@0:  *          orgparam   = *(
michael@0:  *     
michael@0:  *                     ; the following are optional,
michael@0:  *                     ; but MUST NOT occur more than once
michael@0:  *     
michael@0:  *                     (&quot;;&quot; cnparam) / (&quot;;&quot; dirparam) / (&quot;;&quot; sentbyparam) /
michael@0:  *                     (&quot;;&quot; languageparam) /
michael@0:  *     
michael@0:  *                     ; the following is optional,
michael@0:  *                     ; and MAY occur more than once
michael@0:  *     
michael@0:  *                     (&quot;;&quot; xparam)
michael@0:  *     
michael@0:  *                     )
michael@0:  *     
michael@0:  *        Example: The following is an example of this property:
michael@0:  *     
michael@0:  *          ORGANIZER;CN=John Smith:MAILTO:jsmith@host1.com
michael@0:  *     
michael@0:  *        The following is an example of this property with a pointer to the
michael@0:  *        directory information associated with the organizer:
michael@0:  *     
michael@0:  *          ORGANIZER;CN=JohnSmith;DIR=&quot;ldap://host.com:6666/o=3DDC%20Associ
michael@0:  *           ates,c=3DUS??(cn=3DJohn%20Smith)&quot;:MAILTO:jsmith@host1.com
michael@0:  *     
michael@0:  *        The following is an example of this property used by another calendar
michael@0:  *        user who is acting on behalf of the organizer, with responses
michael@0:  *        intended to be sent back to the organizer, not the other calendar
michael@0:  *        user:
michael@0:  *     
michael@0:  *          ORGANIZER;SENT-BY=&quot;MAILTO:jane_doe@host.com&quot;:
michael@0:  *           MAILTO:jsmith@host1.com
michael@0:  * </pre>
michael@0:  * 
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public class Organizer extends Property {
michael@0: 
michael@0:     private static final long serialVersionUID = -5216965653165090725L;
michael@0: 
michael@0:     private URI calAddress;
michael@0: 
michael@0:     /**
michael@0:      * Default constructor.
michael@0:      */
michael@0:     public Organizer() {
michael@0:         super(ORGANIZER, PropertyFactoryImpl.getInstance());
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Constructs a new instance with the specified value.
michael@0:      * @param value an organizer URI
michael@0:      * @throws URISyntaxException where the specified value is not a valid URI
michael@0:      */
michael@0:     public Organizer(String value) throws URISyntaxException {
michael@0:         super(ORGANIZER, PropertyFactoryImpl.getInstance());
michael@0:         setValue(value);
michael@0:     }
michael@0:     
michael@0:     /**
michael@0:      * @param aList a list of parameters for this component
michael@0:      * @param aValue a value string for this component
michael@0:      * @throws URISyntaxException where the specified value string is not a valid uri
michael@0:      */
michael@0:     public Organizer(final ParameterList aList, final String aValue)
michael@0:             throws URISyntaxException {
michael@0:         super(ORGANIZER, aList, PropertyFactoryImpl.getInstance());
michael@0:         setValue(aValue);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aUri a URI representation of a calendar address
michael@0:      */
michael@0:     public Organizer(final URI aUri) {
michael@0:         super(ORGANIZER, PropertyFactoryImpl.getInstance());
michael@0:         calAddress = aUri;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aList a list of parameters for this component
michael@0:      * @param aUri a URI representation of a calendar address
michael@0:      */
michael@0:     public Organizer(final ParameterList aList, final URI aUri) {
michael@0:         super(ORGANIZER, aList, PropertyFactoryImpl.getInstance());
michael@0:         calAddress = aUri;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final void validate() throws ValidationException {
michael@0: 
michael@0:         /*
michael@0:          * ; the following are optional, ; but MUST NOT occur more than once (";" cnparam) / (";" dirparam) / (";"
michael@0:          * sentbyparam) / (";" languageparam) /
michael@0:          */
michael@0:         ParameterValidator.getInstance().assertOneOrLess(Parameter.CN,
michael@0:                 getParameters());
michael@0:         ParameterValidator.getInstance().assertOneOrLess(Parameter.DIR,
michael@0:                 getParameters());
michael@0:         ParameterValidator.getInstance().assertOneOrLess(Parameter.SENT_BY,
michael@0:                 getParameters());
michael@0:         ParameterValidator.getInstance().assertOneOrLess(Parameter.LANGUAGE,
michael@0:                 getParameters());
michael@0: 
michael@0:         /* schedulestatus added for CalDAV scheduling
michael@0:          */
michael@0:         ParameterValidator.getInstance().assertOneOrLess(Parameter.SCHEDULE_STATUS,
michael@0:                                                          getParameters());
michael@0: 
michael@0:         /*
michael@0:          * ; the following is optional, ; and MAY occur more than once (";" xparam)
michael@0:          */
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @return Returns the calAddress.
michael@0:      */
michael@0:     public final URI getCalAddress() {
michael@0:         return calAddress;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final void setValue(final String aValue) throws URISyntaxException {
michael@0:         calAddress = Uris.create(aValue);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final String getValue() {
michael@0:         return Uris.decode(Strings.valueOf(getCalAddress()));
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param calAddress The calAddress to set.
michael@0:      */
michael@0:     public final void setCalAddress(final URI calAddress) {
michael@0:         this.calAddress = calAddress;
michael@0:     }
michael@0: }