01: /******************************************************************************
02: * JBoss, a division of Red Hat *
03: * Copyright 2006, Red Hat Middleware, LLC, and individual *
04: * contributors as indicated by the @authors tag. See the *
05: * copyright.txt in the distribution for a full listing of *
06: * individual contributors. *
07: * *
08: * This is free software; you can redistribute it and/or modify it *
09: * under the terms of the GNU Lesser General Public License as *
10: * published by the Free Software Foundation; either version 2.1 of *
11: * the License, or (at your option) any later version. *
12: * *
13: * This software is distributed in the hope that it will be useful, *
14: * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
16: * Lesser General Public License for more details. *
17: * *
18: * You should have received a copy of the GNU Lesser General Public *
19: * License along with this software; if not, write to the Free *
20: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
21: * 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
22: ******************************************************************************/package org.jboss.portal.api;
23:
24: /**
25: * Base interface for portal urls.
26: *
27: * @author <a href="mailto:julien@jboss.org">Julien Viet</a>
28: * @version $Revision: 8785 $
29: */
30: public interface PortalURL {
31: /**
32: * Affect the authentication mode of the transport protocol that the URL will designate. A null value indicates that
33: * it should reuse the value of the incoming transport.
34: */
35: void setAuthenticated(Boolean wantAuthenticated);
36:
37: /**
38: * Affect the security mode of the transport protocol that the URL will designate. A null value indicates that it
39: * should reuse the value of the incoming transport.
40: */
41: void setSecure(Boolean wantSecure);
42:
43: /** Affet the URL generation by creating either a relative or an absolute URL. */
44: void setRelative(boolean relative);
45:
46: /**
47: * Generate an URL for this node.
48: *
49: * @return a generated url.
50: */
51: String toString();
52: }
|