01: /**
02: * $Id: AddressBookApplicationHelper.java,v 1.9 2003/08/04 14:38:16 byork Exp $
03: * Copyright 2002 Sun Microsystems, Inc. All
04: * rights reserved. Use of this product is subject
05: * to license terms. Federal Acquisitions:
06: * Commercial Software -- Government Users
07: * Subject to Standard License Terms and
08: * Conditions.
09: *
10: * Sun, Sun Microsystems, the Sun logo, and iPlanet
11: * are trademarks or registered trademarks of Sun Microsystems,
12: * Inc. in the United States and other countries.
13: */package com.sun.portal.providers.ab;
14:
15: import java.net.URL;
16: import com.sun.ssoadapter.SSOAdapter;
17: import javax.servlet.http.HttpServletRequest;
18: import javax.servlet.http.HttpServletResponse;
19: import com.sun.portal.providers.context.ProviderContext;
20: import com.sun.portal.providers.ProviderException;
21:
22: /**
23: * <p An AddressBookApplicationHelper implementation must provide the following method(s):
24: * <ul>
25: * <li>init(..)</li>
26: * <li>getStartURL()</li>
27: * </ul>
28: *
29: * @see com.sun.ssoadapter.SSOAdapter
30: *
31: */
32:
33: public interface AddressBookApplicationHelper {
34:
35: /**
36: * Initialize AddressBookApplicationHelper.
37: *
38: * @param provider AddressBook
39: * @param ssoAdapter Used to identify the SSOAdapter
40: */
41: public void init(AddressBookProvider provider, SSOAdapter ssoAdapter)
42: throws Exception;
43:
44: /**
45: * Returns the Application Start URL.
46: *
47: * @param provider AddressBookProvider
48: * @param request HttpServletRequest
49: * @return url to access application
50: */
51: public String getStartURL(AddressBookProvider provider,
52: HttpServletRequest request);
53:
54: /**
55: * Returns the contents of the AddressBookProviders edit page
56: */
57: public StringBuffer getAppPrefsEdit(AddressBookProvider aprov,
58: HttpServletRequest req, HttpServletResponse res);
59:
60: /**
61: * Processes values returned from the AddressBookProvider edit page
62: */
63: public URL processAppPrefsEdit(AddressBookProvider aprov,
64: HttpServletRequest req, HttpServletResponse res)
65: throws ProviderException;
66:
67: /**
68: * Returns a HTML link containing encoding specific for the app helper
69: */
70:
71: public String getAppHelperEditLink(HttpServletRequest req,
72: ProviderContext pc);
73:
74: /**
75: * Sets the App Helpers name
76: */
77: public void setName(String name);
78:
79: /**
80: * Gets the App Helpers name
81: */
82: public String getName();
83:
84: }
|