PortalURL.java :  » Portal » jboss-portal-2.7.2 » org » jboss » portal » api » Java Open Source

Java Open Source » Portal » jboss portal 2.7.2 
jboss portal 2.7.2 » org » jboss » portal » api » PortalURL.java
/******************************************************************************
 * JBoss, a division of Red Hat                                               *
 * Copyright 2006, Red Hat Middleware, LLC, and individual                    *
 * contributors as indicated by the @authors tag. See the                     *
 * copyright.txt in the distribution for a full listing of                    *
 * individual contributors.                                                   *
 *                                                                            *
 * This is free software; you can redistribute it and/or modify it            *
 * under the terms of the GNU Lesser General Public License as                *
 * published by the Free Software Foundation; either version 2.1 of           *
 * the License, or (at your option) any later version.                        *
 *                                                                            *
 * This software is distributed in the hope that it will be useful,           *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU           *
 * Lesser General Public License for more details.                            *
 *                                                                            *
 * You should have received a copy of the GNU Lesser General Public           *
 * License along with this software; if not, write to the Free                *
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA         *
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.                   *
 ******************************************************************************/
package org.jboss.portal.api;

/**
 * Base interface for portal urls.
 *
 * @author <a href="mailto:julien@jboss.org">Julien Viet</a>
 * @version $Revision: 8785 $
 */
public interface PortalURL
{
   /**
    * Affect the authentication mode of the transport protocol that the URL will designate. A null value indicates that
    * it should reuse the value of the incoming transport.
    */
   void setAuthenticated(Boolean wantAuthenticated);

   /**
    * Affect the security mode of the transport protocol that the URL will designate. A null value indicates that it
    * should reuse the value of the incoming transport.
    */
   void setSecure(Boolean wantSecure);

   /** Affet the URL generation by creating either a relative or an absolute URL. */
   void setRelative(boolean relative);

   /**
    * Generate an URL for this node.
    *
    * @return a generated url.
    */
   String toString();
}
java2s.com  | Contact Us | Privacy Policy
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.