Java Doc for ProfileProviderAdapter.java in  » Portal » Open-Portal » com » sun » portal » providers » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Portal » Open Portal » com.sun.portal.providers 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sun.portal.providers.ProviderAdapter
      com.sun.portal.providers.ProfileProviderAdapter

All known Subclasses:   com.sun.portal.providers.userinfo.UserInfoProvider,  com.sun.portal.providers.mailcheck.MailCheckProvider,  com.sun.portal.providers.proxylet.ProxyletProvider,  com.sun.portal.providers.notes.NotesProvider,  __PACKAGE__.__NAME__,  com.sun.portal.providers.pctest.PCTestProvider,  com.sun.portal.taskadmin.test.TaskAdminPortletTestProvider,  samples.quotation.QuotationProvider,  com.sun.portal.providers.calendar.CalendarProvider,  com.sun.portal.providers.urlscraper.URLScraperProvider,  com.sun.portal.providers.jsp.JSPProvider,  com.sun.portal.providers.bookmark.BookmarkProvider,  com.sun.portal.providers.containers.ContainerProviderAdapter,  com.sun.portal.community.mc.test.provider.CommunityTestProvider,  com.sun.portal.providers.mail.MailProvider,  com.sun.portal.providers.login.LoginProvider,  com.sun.portal.taskadmin.test.TaskAdminUserTestProvider,  com.sun.portal.providers.personalnote.PersonalNoteProvider,  com.sun.portal.providers.dptest.DPTestProvider,  com.sun.portal.providers.netlet.NetletProvider,  com.sun.portal.providers.compass.CompassProvider,  com.sun.portal.providers.app.AppProvider,  com.sun.portal.taskadmin.test.TaskAdminTestProvider,  com.sun.portal.providers.ab.AddressBookProvider,  com.sun.portal.community.test.provider.CommunityMgmntTestProvider,
ProfileProviderAdapter
abstract public class ProfileProviderAdapter extends ProviderAdapter (Code)
This class adds convenience wrappers around some commonly used methods in the ProviderContext interface.


See Also:   com.sun.portal.providers.Provider
See Also:   com.sun.portal.providers.ProviderAdapter
See Also:   com.sun.portal.providers.context.ProviderContext




Method Summary
public  booleanexistsBooleanProperty(String name)
     Tests for the existence of a boolean property in the channel.
public  booleanexistsIntegerProperty(String name)
     Tests for the existence of an integer property in the channel.
public  booleanexistsListProperty(String name)
     Tests for the existence of a list property in the channel.
public  booleanexistsListProperty(String name, boolean localized)
     Tests for the existence of a listproperty in the channel.

This method will also check for the existence of the localized version of the property.


Parameters:
  name - A String, the property name.
Parameters:
  localized - A boolean, whether to check the existence of localized properties.

public  booleanexistsStringProperty(String name)
     Tests for the existence of a string property in the channel.
Parameters:
  name - A String, the property name.
public  booleanexistsStringProperty(String name, boolean localized)
     Tests for the existence of a string property in the channel.

This method will also check for the existence of the localized version of the property.


Parameters:
  name - A String, the property name.
Parameters:
  localized - A boolean, whether to check the existence of localized properties.

public  booleangetBooleanProperty(String key)
     Get a boolean property for the channel.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be returned.

public  booleangetBooleanProperty(String key, List pflist)
     Get the filtered boolean property for the channel.

This method assumes that the property is defined.

Filter criteria can be specified using a series of PropertiesFilter objects.

public  booleangetBooleanProperty(String key, boolean def)
     Get a boolean property for the channel.

This method returns a default value if the property does not exist.


Parameters:
  key - The key for the property to be returned.
Parameters:
  def - Default value.

public  booleangetBooleanProperty(String key, boolean def, List pflist)
     Get the filtered boolean property for the channel.

This method returns a default value if the property does not exist.

Filter criteria can be specified using a series of PropertiesFilter objects.

public  StringgetClientProperty(String name)
     Get the client property.
Parameters:
  name - Property name.
public  intgetIntegerProperty(String key)
     Get an integer property for the channel.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be returned.

public  intgetIntegerProperty(String key, List pflist)
     Get an integer property for the channel.

This method assumes that the property is defined.

Filter criteria can be specified using a series of PropertiesFilter objects.

public  intgetIntegerProperty(String key, int def)
     Get an integer property for the channel.
public  intgetIntegerProperty(String key, int def, List pflist)
     Get an integer property for the channel.

This method returns a default value if the property does not exist.

Filter criteria can be specified using a series of PropertiesFilter objects.

public  ListgetListProperty(String key)
     Get a list property for the channel.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be returned.

public  ListgetListProperty(String key, List def)
     Get a list property for the provider.

This method will return the defaule list passed in if the property is undefined for the channel.


Parameters:
  key - The key for the property to be returned.
Parameters:
  def - The default list to be returned if the propertydoes not exist.

public  MapgetMapProperty(String key)
     Get a map property for the channel.

This method assumes that the property is defined.

The Java Map object returned from this method does not fronts the persistent store for the property. Changes to the return value are not persisted. Changes must be persisted with setMapProperty() call.

public  MapgetMapProperty(String key, List pflist)
     Get the filtered map property for the channel.

Filter criteria can be specified using a series of PropertiesFilter objects.

public  MapgetMapProperty(String key, boolean localized)
     Get the localized version of a map property for the channel.

If localized is true, then this method will attempt to find a localized version of the map named by the key.

public  MapgetMapProperty(String key, Map def)
     Get a map property for the channel.
public  MapgetMapProperty(String key, Map def, List pflist)
     Get the filtered map property for the channel.

Filter criteria can be specified using a series of PropertiesFilter objects.

public  MapgetMapProperty(String key, Map def, boolean localized)
     Get the localized version of a map property for the channel.

If localized is true, then this method will attempt to find a localized version of the map named by the key.

public  StringgetStringAttribute(String name)
     Get a string attribute.

"Attributes" are settings that are not channel-specific.

public  StringgetStringProperty(String key)
     Get a string property for the channel.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be returned.

public  StringgetStringProperty(String key, String def)
     Get a string property for the channel.
public  StringgetStringProperty(String key, List pflist)
     Get a filtered string property for the channel.

Filter criteria can be specified using a series of PropertiesFilter objects.

public  StringgetStringProperty(String key, String def, List pflist)
     Get a filtered string property for the channel.

Filter criteria can be specified using a series of PropertiesFilter objects.

public  StringgetStringProperty(String key, boolean localized)
     Get a localized string property for the channel.

If localized is true, then this method will attempt to find a localized version of the string named by the key.

public  StringgetStringProperty(String key, String def, boolean localized)
     Get a localized string property for the channel.

If localized is true, then this method will attempt to find a localized version of the string named by the key.

public  StringBuffergetTemplate(String file)
    

Get template for the provider.

public  StringBuffergetTemplate(String file, Hashtable table)
    

Get template for the provider, and tag swap the results before returning.

public  FilegetTemplatePath(String file)
    

Get the template path for the given channel name and the given template name.

public  booleanisAllowed(String priv)
     Checks for access to the named privilege.

This method is provided for backwards compatibility.

public  booleansetBooleanProperty(String key, boolean val)
     Sets a boolean property for the channel.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be set.
Parameters:
  val - The value for the propery to be set.

public  voidsetClientProperty(String name, String val)
     Sets a client property.
public  intsetIntegerProperty(String key, int val)
     Sets a integer property for the channel.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be set.
Parameters:
  val - The value for the propery to be set.

public  ListsetListProperty(String key, List val)
     Sets a list property for the channel.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be set.
Parameters:
  val - The value for the propery to be set.

public  MapsetMapProperty(String key, Map val)
     Sets a map property for the channel.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be set.
Parameters:
  val - The value for the propery to be set.

public  voidsetStringAttribute(String name, String val)
     Sets a string attribute.

"Attributes" are settings that are not channel-specific.

public  StringsetStringProperty(String key, String val)
     Sets a string property for the channel.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be set.
Parameters:
  val - The value for the propery to be set.




Method Detail
existsBooleanProperty
public boolean existsBooleanProperty(String name) throws ProviderException(Code)
Tests for the existence of a boolean property in the channel.
Parameters:
  name - A String, the property name. A boolean, true if the property exists, otherwise false.



existsIntegerProperty
public boolean existsIntegerProperty(String name) throws ProviderException(Code)
Tests for the existence of an integer property in the channel.
Parameters:
  name - A String, the property name. A boolean, true if the property exists, otherwise false.



existsListProperty
public boolean existsListProperty(String name) throws ProviderException(Code)
Tests for the existence of a list property in the channel.
Parameters:
  name - A String, the property name. A boolean, true if the property exists, otherwise false.



existsListProperty
public boolean existsListProperty(String name, boolean localized) throws ProviderException(Code)
Tests for the existence of a listproperty in the channel.

This method will also check for the existence of the localized version of the property.


Parameters:
  name - A String, the property name.
Parameters:
  localized - A boolean, whether to check the existence of localized properties. A boolean, true if the property exists, otherwise false.




existsStringProperty
public boolean existsStringProperty(String name) throws ProviderException(Code)
Tests for the existence of a string property in the channel.
Parameters:
  name - A String, the property name. A boolean, true if the property exists, otherwise false.



existsStringProperty
public boolean existsStringProperty(String name, boolean localized) throws ProviderException(Code)
Tests for the existence of a string property in the channel.

This method will also check for the existence of the localized version of the property.


Parameters:
  name - A String, the property name.
Parameters:
  localized - A boolean, whether to check the existence of localized properties. A boolean, true if the property exists, otherwise false.




getBooleanProperty
public boolean getBooleanProperty(String key) throws ProviderException(Code)
Get a boolean property for the channel.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be returned. The boolean value corresponding to the key.




getBooleanProperty
public boolean getBooleanProperty(String key, List pflist) throws ProviderException(Code)
Get the filtered boolean property for the channel.

This method assumes that the property is defined.

Filter criteria can be specified using a series of PropertiesFilter objects. The order in that the PropertiesFilter objects are listed determines the order that the property is searched. If there is no property that exactly matches the filter criteria, the best partial match is returned. When there is not even a partial match, an unfiltered property is returned. If the unfiltered property is unavailble, then the default value is returned.


Parameters:
  key - The key for the property to be returned.
Parameters:
  pflist - An ordered list of PropertiesFilter objects The boolean value corresponding to the key.




getBooleanProperty
public boolean getBooleanProperty(String key, boolean def) throws ProviderException(Code)
Get a boolean property for the channel.

This method returns a default value if the property does not exist.


Parameters:
  key - The key for the property to be returned.
Parameters:
  def - Default value. The boolean value corresponding to the key.




getBooleanProperty
public boolean getBooleanProperty(String key, boolean def, List pflist) throws ProviderException(Code)
Get the filtered boolean property for the channel.

This method returns a default value if the property does not exist.

Filter criteria can be specified using a series of PropertiesFilter objects. The order in that the PropertiesFilter objects are listed determines the order that the property is searched. If there is no property that exactly matches the filter criteria, the best partial match is returned. When there is not even a partial match, an unfiltered property is returned. If the unfiltered property is unavailble, then the default value is returned.


Parameters:
  key - The key for the property to be returned.
Parameters:
  def - Default value.
Parameters:
  pflist - An ordered list of PropertiesFilter objects The boolean value corresponding to the key.




getClientProperty
public String getClientProperty(String name)(Code)
Get the client property.
Parameters:
  name - Property name. Property value. If the property isnot not found, then null is returned.



getIntegerProperty
public int getIntegerProperty(String key) throws ProviderException(Code)
Get an integer property for the channel.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be returned. The integer value corresponding to the key.




getIntegerProperty
public int getIntegerProperty(String key, List pflist) throws ProviderException(Code)
Get an integer property for the channel.

This method assumes that the property is defined.

Filter criteria can be specified using a series of PropertiesFilter objects. The order in that the PropertiesFilter objects are listed determines the order that the property is searched. If there is no property that exactly matches the filter criteria, the best partial match is returned. When there is not even a partial match, an unfiltered property is returned. If the unfiltered property is unavailble, then the default value is returned.


Parameters:
  key - The key for the property to be returned.
Parameters:
  pflist - An ordered list of PropertiesFilter objects The integer value corresponding to the key.




getIntegerProperty
public int getIntegerProperty(String key, int def) throws ProviderException(Code)
Get an integer property for the channel.

This method returns a default value if the property does not exist.


Parameters:
  key - The key for the property to be returned.
Parameters:
  def - Default value. The integer value corresponding to the key.




getIntegerProperty
public int getIntegerProperty(String key, int def, List pflist) throws ProviderException(Code)
Get an integer property for the channel.

This method returns a default value if the property does not exist.

Filter criteria can be specified using a series of PropertiesFilter objects. The order in that the PropertiesFilter objects are listed determines the order that the property is searched. If there is no property that exactly matches the filter criteria, the best partial match is returned. When there is not even a partial match, an unfiltered property is returned. If the unfiltered property is unavailble, then the default value is returned.


Parameters:
  key - The key for the property to be returned.
Parameters:
  def - Default value.
Parameters:
  pflist - An ordered list of PropertiesFilter objects The integer value corresponding to the key.




getListProperty
public List getListProperty(String key) throws ProviderException(Code)
Get a list property for the channel.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be returned. The list value corresponding to the key.




getListProperty
public List getListProperty(String key, List def) throws ProviderException(Code)
Get a list property for the provider.

This method will return the defaule list passed in if the property is undefined for the channel.


Parameters:
  key - The key for the property to be returned.
Parameters:
  def - The default list to be returned if the propertydoes not exist. The list value corresponding to the key.




getMapProperty
public Map getMapProperty(String key) throws ProviderException(Code)
Get a map property for the channel.

This method assumes that the property is defined.

The Java Map object returned from this method does not fronts the persistent store for the property. Changes to the return value are not persisted. Changes must be persisted with setMapProperty() call. For example,

Map m = p.getMapProperty("foo");
m.put("a", "1");
p.setMapProperty("foo", m);


Parameters:
  key - The key for the property to be returned. The map value corresponding to the key.




getMapProperty
public Map getMapProperty(String key, List pflist) throws ProviderException(Code)
Get the filtered map property for the channel.

Filter criteria can be specified using a series of PropertiesFilter objects. The order in that the PropertiesFilter objects are listed determines the order that the property is searched. If there is no property that exactly matches the filter criteria, the best partial match is returned. When there is not even a partial match, an unfiltered property is returned. If the unfiltered property is unavailble, then the default value is returned.


Parameters:
  key - The key for the property to be returned.
Parameters:
  pflist - An ordered list of PropertiesFilter objects. The map value corresponding to the key and the filters.
See Also:   PropertiesFilter




getMapProperty
public Map getMapProperty(String key, boolean localized) throws ProviderException(Code)
Get the localized version of a map property for the channel.

If localized is true, then this method will attempt to find a localized version of the map named by the key. The locale for the user who this object is executing is read from the ProviderContext object associated with this providero object. Locale-based maps are searched for from more specific to less specific locales. For exmaple, if the user locale was "en_US_SW", the search order would be:

  • Look for map matching key under locale en_US_SW
  • Look for map matching key under locale en_US
  • Look for map matching key under locale en
  • Look for non-locale specific key


This lookup order is the same as defined by Java resource bundles.

If a locale version of this map is not found, and a non-locale version of this map is not found, then an java.lang.Error is thrown. Client of this call can catch the error and provide code to handle the error condition accordingly.


Parameters:
  key - The key for the property to be returned.
Parameters:
  localized - If true, first search for a localized map matchingthe given key. The map value corresponding to the key.



getMapProperty
public Map getMapProperty(String key, Map def) throws ProviderException(Code)
Get a map property for the channel.

This method returns a default value if the property does not exist.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be returned.
Parameters:
  def - Default value. The map value corresponding to the key.




getMapProperty
public Map getMapProperty(String key, Map def, List pflist) throws ProviderException(Code)
Get the filtered map property for the channel.

Filter criteria can be specified using a series of PropertiesFilter objects. The order in that the PropertiesFilter objects are listed determines the order that the property is searched. If there is no property that exactly matches the filter criteria, the best partial match is returned. When there is not even a partial match, an unfiltered property is returned. If the unfiltered property is unavailble, then the default value is returned.


Parameters:
  key - The key for the property to be returned.
Parameters:
  def - Default value.
Parameters:
  pflist - An ordered list of PropertiesFilter objects The map value corresponding to the key and the filters.
See Also:   PropertiesFilter




getMapProperty
public Map getMapProperty(String key, Map def, boolean localized) throws ProviderException(Code)
Get the localized version of a map property for the channel.

If localized is true, then this method will attempt to find a localized version of the map named by the key. The locale for the user who this object is executing is read from the ProviderContext object associated with this providero object. Locale-based maps are searched for from more specific to less specific locales. For exmaple, if the user locale was "en_US_SW", the search order would be:

  • Look for map matching key under locale en_US_SW
  • Look for map matching key under locale en_US
  • Look for map matching key under locale en
  • Look for non-locale specific key


This lookup order is the same as defined by Java resource bundles.

If a locale version of this map is not found, and a non-locale version of this string is not found, then this method returns a default value.


Parameters:
  key - The key for the property to be returned.
Parameters:
  def - Default value.
Parameters:
  localized - If true, first search for a localized map matchingthe given key. The map value corresponding to the key.



getStringAttribute
public String getStringAttribute(String name)(Code)
Get a string attribute.

"Attributes" are settings that are not channel-specific. An example of an attribute might be the user's first and last name. Channel-specific settings are called "properties".

Properties can be retrieved by calling the get*Property() methods. Whether a particular value is considered a property or an attribute depends on the underlying implementation of ProviderContext.


Parameters:
  name - Attribute name. Attribute value as a string. If attribute isnot not found, null is returned.




getStringProperty
public String getStringProperty(String key) throws ProviderException(Code)
Get a string property for the channel.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be returned. The string value corresponding to the key.
exception:
  ProviderException - if an error occurs in getting theString property.




getStringProperty
public String getStringProperty(String key, String def) throws ProviderException(Code)
Get a string property for the channel.

This method returns a default value if the property does not exist.


Parameters:
  key - The key for the property to be returned.
Parameters:
  def - The default value to be returned if the propertydoes not exist. The string value corresponding to the key.
exception:
  ProviderException - if an error occurs in getting theString property.




getStringProperty
public String getStringProperty(String key, List pflist) throws ProviderException(Code)
Get a filtered string property for the channel.

Filter criteria can be specified using a series of PropertiesFilter objects. The order in that the PropertiesFilter objects are listed determines the order that the property is searched. If there is no property that exactly matches the filter criteria, the best partial match is returned. When there is not even a partial match, an unfiltered property is returned.


Parameters:
  key - The key for the property to be returned.
Parameters:
  pflist - An ordered list of PropertiesFilter objects The string value corresponding to the key.
exception:
  ProviderException - if an error occurs in getting the filteredString property.
See Also:   PropertiesFilter




getStringProperty
public String getStringProperty(String key, String def, List pflist) throws ProviderException(Code)
Get a filtered string property for the channel.

Filter criteria can be specified using a series of PropertiesFilter objects. The order in that the PropertiesFilter objects are listed determines the order that the property is searched. If there is no property that exactly matches the filter criteria, the best partial match is returned. When there is not even a partial match, an unfiltered property is returned. If the unfiltered property is unavailble, then the default value is returned.


Parameters:
  key - The key for the property to be returned.
Parameters:
  def - Default value.
Parameters:
  pflist - An ordered list of PropertiesFilter objects The string value corresponding to the key.
exception:
  ProviderException - if an error occurs in getting the filteredString property.
See Also:   PropertiesFilter




getStringProperty
public String getStringProperty(String key, boolean localized) throws ProviderException(Code)
Get a localized string property for the channel.

If localized is true, then this method will attempt to find a localized version of the string named by the key. The locale for the user who this object is executing is read from the ProviderContext object associated with this provider object. Locale-based strings are searched for from more specific to less specific locales. For exmaple, if the user locale was "en_US_SW", the search order would be:

  • Look for string matching key under locale en_US_SW
  • Look for string matching key under locale en_US
  • Look for string matching key under locale en
  • Look for non-locale specific key


This lookup order is the same as defined by Java resource bundles.

If a locale version of this string is not found, and a non-locale version of this string is not found, then an java.lang.Error is thrown. Client of this call can catch the error and provide code to handle the error condition accordingly.


Parameters:
  key - The key for the property to be returned.
Parameters:
  localized - If true, first search for a localized string matchingthe given key. The string value corresponding to the key.
exception:
  ProviderException - if an error occurs in getting the localized String property.



getStringProperty
public String getStringProperty(String key, String def, boolean localized) throws ProviderException(Code)
Get a localized string property for the channel.

If localized is true, then this method will attempt to find a localized version of the string named by the key. The locale for the user who this object is executing is read from the ProviderContext object associated with this provider object. Locale-based strings are searched for from more specific to less specific locales. For exmaple, if the user locale was "en_US_SW", the search order would be:

  • Look for string matching key under locale en_US_SW
  • Look for string matching key under locale en_US
  • Look for string matching key under locale en
  • Look for non-locale specific key


This lookup order is the same as defined by Java resource bundles. If a locale version of this string is not found, and a non-locale version of this string is not found, then this method returns a default value.


Parameters:
  key - The key for the property to be returned.
Parameters:
  def - Default value.
Parameters:
  localized - If true, first search for a localized string matchingthe given key. The string value corresponding to the key.
exception:
  ProviderException - if an error occurs in getting the localizedString property.



getTemplate
public StringBuffer getTemplate(String file) throws ProviderException(Code)

Get template for the provider.

The directory search order of the template file is as follows:

  • <type>_<locale>/<component>/<clientPath>
  • <type>_<locale>/<component>
  • <type>_<locale>/<clientPath>
  • <type>_<locale>
  • <type>/<component>/<clientPath>
  • <type>/<component>
  • <type>
  • default_<locale>/<component>/<clientPath>
  • default_<locale>/<component>
  • default_<locale>
  • default/<component>/<clientPath>
  • default/<component>
  • default/<clientPath>
  • default

Where

  1. <type> is the value of the desktop template type property
  2. <locale> is the user's locale
  3. <component> is the component name (or channel name)
  4. <clientPath> is an optional file-path containing client-specific templates

If there is no <clientPath> specified, then the directory search order is as follows:

  • <type>_<locale>/<component>
  • <type>_<locale>
  • <type>/<component>
  • <type>
  • default_<locale>/<component>
  • default_<locale>
  • default/<component>
  • default



Parameters:
  file - The template file name template A StringBuffer represents the template



getTemplate
public StringBuffer getTemplate(String file, Hashtable table) throws ProviderException(Code)

Get template for the provider, and tag swap the results before returning.
See Also:   ProfileProviderAdapter.getTemplate(String)




getTemplatePath
public File getTemplatePath(String file) throws ProviderException(Code)

Get the template path for the given channel name and the given template name. If non-null, the key returned by this method will map to a most specific, existing template file. The format of the returned path is implementation dependent.
See Also:   ProfileProviderAdapter.getTemplate(String)




isAllowed
public boolean isAllowed(String priv) throws ProviderException(Code)
Checks for access to the named privilege.

This method is provided for backwards compatibility. There is no longer a concept of a privilege in the Provider API. Instead, use boolean properties.

This method simply calls getBooleanProperty() to determine its return value.


Parameters:
  priv - The privilege to check. A boolean value. true if the user is granted access by the namedprivilege, otherwise false.




setBooleanProperty
public boolean setBooleanProperty(String key, boolean val) throws ProviderException(Code)
Sets a boolean property for the channel.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be set.
Parameters:
  val - The value for the propery to be set. The previous value.




setClientProperty
public void setClientProperty(String name, String val)(Code)
Sets a client property.
Parameters:
  name - The property name.
Parameters:
  value - The property value.



setIntegerProperty
public int setIntegerProperty(String key, int val) throws ProviderException(Code)
Sets a integer property for the channel.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be set.
Parameters:
  val - The value for the propery to be set. The previous value.




setListProperty
public List setListProperty(String key, List val) throws ProviderException(Code)
Sets a list property for the channel.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be set.
Parameters:
  val - The value for the propery to be set. The previous value.




setMapProperty
public Map setMapProperty(String key, Map val) throws ProviderException(Code)
Sets a map property for the channel.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be set.
Parameters:
  val - The value for the propery to be set. The previous value.




setStringAttribute
public void setStringAttribute(String name, String val)(Code)
Sets a string attribute.

"Attributes" are settings that are not channel-specific. An example of an attribute might be the user's first and last name. Channel-specific settings are called "properties".

Properties can be set by calling the set*Property() methods. Whether a particular value is considered a property or an attribute depends on the underlying implementation of ProviderContext.


Parameters:
  name - Attribute name.
Parameters:
  name - Attribute value.




setStringProperty
public String setStringProperty(String key, String val) throws ProviderException(Code)
Sets a string property for the channel.

This method assumes that the property is defined.


Parameters:
  key - The key for the property to be set.
Parameters:
  val - The value for the propery to be set. The previous value.




Methods inherited from com.sun.portal.providers.ProviderAdapter
String getClientTypeProperty(String propertyName) throws ProviderException(Code)(Java Doc)
public StringBuffer getContent(HttpServletRequest request, HttpServletResponse response) throws ProviderException(Code)(Java Doc)
public StringBuffer getContent(Map m) throws ProviderException(Code)(Java Doc)
public String getDescription() throws ProviderException(Code)(Java Doc)
public StringBuffer getEdit(HttpServletRequest request, HttpServletResponse response) throws ProviderException(Code)(Java Doc)
public StringBuffer getEdit(Map m) throws ProviderException(Code)(Java Doc)
public int getEditType() throws UnknownEditTypeException(Code)(Java Doc)
public URL getHelp(HttpServletRequest req, String key) throws ProviderException(Code)(Java Doc)
public URL getHelp(HttpServletRequest req) throws ProviderException(Code)(Java Doc)
public String getName()(Code)(Java Doc)
public ProviderContext getProviderContext()(Code)(Java Doc)
public long getRefreshTime() throws ProviderException(Code)(Java Doc)
public ResourceBundle getResourceBundle(String base) throws ProviderException(Code)(Java Doc)
public ResourceBundle getResourceBundle() throws ProviderException(Code)(Java Doc)
public String getTitle() throws ProviderException(Code)(Java Doc)
public int getWidth() throws ProviderException(Code)(Java Doc)
public void init(String n, HttpServletRequest req) throws ProviderException(Code)(Java Doc)
public boolean isEditable() throws ProviderException(Code)(Java Doc)
public boolean isPresentable()(Code)(Java Doc)
public boolean isPresentable(HttpServletRequest req)(Code)(Java Doc)
public URL processEdit(HttpServletRequest request, HttpServletResponse response) throws ProviderException(Code)(Java Doc)
public URL processEdit(Map m) throws ProviderException(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.