A C D E F G H I J L M N O P R S T U V W

A

addProfileListener(ProfileListener) - Method in class com.iplanet.portalserver.profile.Profile
Adds specified profile listener to receive any profile change events from this profile.
addSessionListener(SessionListener) - Method in class com.iplanet.portalserver.session.Session
Adds a session listener for session change events.
addSessionListenerOnAllSessions(SessionListener) - Method in class com.iplanet.portalserver.session.Session
Adds a session listner for all sessions residing on the same session server as this session object resides.
addSessionListenerOnAllSessions(String, SessionListener) - Method in class com.iplanet.portalserver.session.Session
Adds a session listner for all sessions on the specified session server.
ALL - Static variable in class com.iplanet.portalserver.profile.Profile
All profile types
ALREADY_EXISTS - Static variable in class com.iplanet.portalserver.logging.LogException
log already exists
APPEND - Static variable in class com.iplanet.portalserver.profile.Profile
Append attribute value
APPLICATION - Static variable in class com.iplanet.portalserver.profile.Profile
Application profile type
APPLICATION_SESSION - Static variable in class com.iplanet.portalserver.session.Session
 
AsciiFormInputExpectedException - exception com.iplanet.portalserver.providers.AsciiFormInputExpectedException.
This exception should be thrown from processEditForm when it requires ASCII-only encoded form input but is sent something else.
AsciiFormInputExpectedException() - Constructor for class com.iplanet.portalserver.providers.AsciiFormInputExpectedException
 
AsciiFormInputExpectedException(String) - Constructor for class com.iplanet.portalserver.providers.AsciiFormInputExpectedException
 

C

com.iplanet.portalserver.auth.server - package com.iplanet.portalserver.auth.server
 
com.iplanet.portalserver.logging - package com.iplanet.portalserver.logging
 
com.iplanet.portalserver.profile - package com.iplanet.portalserver.profile
 
com.iplanet.portalserver.providers - package com.iplanet.portalserver.providers
 
com.iplanet.portalserver.providers.jsp - package com.iplanet.portalserver.providers.jsp
 
com.iplanet.portalserver.session - package com.iplanet.portalserver.session
 
CONNECTION_FALIED - Static variable in class com.iplanet.portalserver.logging.LogException
log jdbc driver connection failed
CREATE_ACCESS_DENIED - Static variable in class com.iplanet.portalserver.logging.LogException
log creation privilege is denied
create(String) - Method in class com.iplanet.portalserver.logging.LogManager
Create a log in the logging directory.

D

DBDRIVER - Static variable in class com.iplanet.portalserver.logging.LogManager
log database driver
DBPASS - Static variable in class com.iplanet.portalserver.logging.LogManager
log database pass
DBUSER - Static variable in class com.iplanet.portalserver.logging.LogManager
log database user
Debug - class com.iplanet.portalserver.util.Debug.
Allows a uniform interface to file debug and exception information in a uniform format.
Debug(String) - Constructor for class com.iplanet.portalserver.util.Debug
This constructor takes as an argument the name of the debug file.
debugEnabled() - Method in class com.iplanet.portalserver.util.Debug
Checks if message debugging is enabled.
delAttribute(String) - Method in class com.iplanet.portalserver.profile.Profile
Deletes attribute from profile.
delAttributes(String) - Method in class com.iplanet.portalserver.profile.Profile
Deletes attributes which match wildchar expression from profile.
DELETE - Static variable in class com.iplanet.portalserver.profile.Profile
Delete attribute value
DELETE_ACCESS_DENIED - Static variable in class com.iplanet.portalserver.logging.LogException
log deletion privilege is denied
DELETE_ERROR - Static variable in class com.iplanet.portalserver.logging.LogException
log deletion error
delete(String) - Method in class com.iplanet.portalserver.logging.LogManager
Delete a log from the system.
DesktopURL - class com.iplanet.portalserver.providers.DesktopURL.
This class helps build URLs that refer back to the iPS Desktop Servlet.
DesktopURL(Session) - Constructor for class com.iplanet.portalserver.providers.DesktopURL
Construct the default desktop URL to fetch the front page.
DesktopURL(Session, String) - Constructor for class com.iplanet.portalserver.providers.DesktopURL
Construct a desktop URL with custom parameters.
DesktopURL(String) - Constructor for class com.iplanet.portalserver.providers.DesktopURL
Construct a custom desktop url.
DesktopURL(URL) - Constructor for class com.iplanet.portalserver.providers.DesktopURL
Construct a desktop URL based on an existing URL.
DESTROY - Static variable in class com.iplanet.portalserver.session.SessionEvent
Session destroy event
destroy() - Method in class com.iplanet.portalserver.util.Debug
Destroys the debug object, closes the debug file and releases any system resources.
DESTROYED - Static variable in class com.iplanet.portalserver.session.Session
 
destroySession(Session) - Method in class com.iplanet.portalserver.session.Session
Destroy a session.
DOMAIN - Static variable in class com.iplanet.portalserver.profile.Profile
Domain profile type
DRIVER_LOAD_FAILED - Static variable in class com.iplanet.portalserver.logging.LogException
log jdbc driver loading failed

E

EDIT_COMPLETE - Static variable in interface com.iplanet.portalserver.providers.Provider
Edit page is a complete HTML document.
EDIT_SUBSET - Static variable in interface com.iplanet.portalserver.providers.Provider
Edit page is not a complete HTML document.
encodeURL(HttpServletResponse, String) - Method in class com.iplanet.portalserver.session.Session
Returns the encoded URL , rewriten to include the session id.
encodeURL(String) - Method in class com.iplanet.portalserver.session.Session
Returns the encoded URL , rewritten to include the session id.
equals(Object) - Method in class com.iplanet.portalserver.session.SessionID
Compares this SessionID to the specified object.
ERROR - Static variable in class com.iplanet.portalserver.util.Debug
flags the state where error debugging is enabled.
error(String) - Method in class com.iplanet.portalserver.util.Debug
Prints error messages only when debug level is greater than DEBUG.OFF.
error(String, Throwable) - Method in class com.iplanet.portalserver.util.Debug
Prints error messages only if debug state is greater than Debug.OFF.

F

FATAL_ERROR - Static variable in class com.iplanet.portalserver.logging.LogException
other unkown fatal error

G

getAllTokenNames() - Method in class com.iplanet.portalserver.auth.server.Login
Returns all of the token names for the current authentication state
getAllTokens() - Method in class com.iplanet.portalserver.auth.server.Login
Returns all the user entered tokens in the current authentication state.
getAllTokensForState(int) - Method in class com.iplanet.portalserver.auth.server.Login
Returns all the user entered tokens in the specified authentication state.
getApplicationProfile(String) - Method in class com.iplanet.portalserver.auth.server.Login
 
getAppProfile(String) - Method in class com.iplanet.portalserver.session.Session
Gets the application profile.
getAttribute(String) - Method in class com.iplanet.portalserver.profile.Profile
Gets attribute value.
getAttributes() - Method in class com.iplanet.portalserver.profile.Profile
Gets hashtable of profile attributes.
getAttributes(String) - Method in class com.iplanet.portalserver.profile.Profile
Gets hashtable of profile attributes.
getAttributeString(String) - Method in class com.iplanet.portalserver.profile.Profile
Gets string type attribute value.
getAuthLevel() - Method in class com.iplanet.portalserver.auth.server.Login
 
getBackgroundColor() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
getBackgroundColor() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
getBackgroundColor() - Method in interface com.iplanet.portalserver.providers.Provider
Get the background color for this provider.
getClientDomain() - Method in class com.iplanet.portalserver.session.Session
Returns the client domain in the session.
getClientID() - Method in class com.iplanet.portalserver.session.Session
Returns the client ID in the session.
getColumn() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
getColumn() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
getColumn() - Method in interface com.iplanet.portalserver.providers.Provider
Get the column in which this provider should be displayed in.
getContent(HttpServletRequest, HttpServletResponse) - Method in class com.iplanet.portalserver.providers.ProviderAdapter
Call getContent(Map) with the request parameters.
getContent(HttpServletRequest, HttpServletResponse) - Method in interface com.iplanet.portalserver.providers.Provider
Get the provider's content.
getContent(HttpServletRequest, HttpServletResponse) - Method in class com.iplanet.portalserver.providers.jsp.JSPProvider
Get the provider's content by executing a JSP.
getContent(Map) - Method in class com.iplanet.portalserver.providers.ProviderAdapter
This method has no effect.
getContent(Map) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
getContent(Map) - Method in interface com.iplanet.portalserver.providers.Provider
Get the provider's content (alternate form).
getContent(Map) - Method in class com.iplanet.portalserver.providers.jsp.JSPProvider
Get the provider's content page by executing a JSP.
getCurrentState() - Method in class com.iplanet.portalserver.auth.server.Login
Returns the current state in the authentication process.
getDescription() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
getDescription() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Get the description for this channel.
getDescription() - Method in interface com.iplanet.portalserver.providers.Provider
Get the description of this provider.
getDomainProfile(String) - Method in class com.iplanet.portalserver.auth.server.Login
 
getEdit(HttpServletRequest, HttpServletResponse) - Method in class com.iplanet.portalserver.providers.ProviderAdapter
Call getEdit(Map) with the request parameters.
getEdit(HttpServletRequest, HttpServletResponse) - Method in interface com.iplanet.portalserver.providers.Provider
Get the edit page of the provider.
getEdit(HttpServletRequest, HttpServletResponse) - Method in class com.iplanet.portalserver.providers.jsp.JSPProvider
Get the provider's edit page by executing a JSP.
getEdit(Map) - Method in class com.iplanet.portalserver.providers.ProviderAdapter
This method has no effect.
getEdit(Map) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
getEdit(Map) - Method in interface com.iplanet.portalserver.providers.Provider
Get the edit page of the provider (alternate form).
getEdit(Map) - Method in class com.iplanet.portalserver.providers.jsp.JSPProvider
Get the provider's edit page by executing a JSP.
getEditType() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
getEditType() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
getEditType() - Method in interface com.iplanet.portalserver.providers.Provider
Get the edit form type of the provider.
getEventType() - Method in class com.iplanet.portalserver.session.Session
Returns the type of the event which caused the state change of this session.
getHelp() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
getHelp() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
getHelp() - Method in interface com.iplanet.portalserver.providers.Provider
Get the help link for this provider.
getHttpServletRequest() - Method in class com.iplanet.portalserver.auth.server.Login
Returns the request object for the HttpServletRequest object which initiated the call to this module.
getHttpServletResponse() - Method in class com.iplanet.portalserver.auth.server.Login
Returns the HttpServletResponse object for the servlet request which initiated the call to this module.
getID() - Method in class com.iplanet.portalserver.session.Session
Returns the session ID.
getIdleTime() - Method in class com.iplanet.portalserver.session.Session
Returns the session idle time in seconds.
getInstance(String) - Static method in class com.iplanet.portalserver.util.Debug
Gets an existing instance of Debug for the specified debug file or a new one if no such instance already exists.
getListProperty(String, String, Vector) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Get a list property for the provider.
getListProperty(String, Vector) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Get a list property for the provider.
getLocale() - Method in class com.iplanet.portalserver.auth.server.Login
 
getLogAttrs(String) - Method in class com.iplanet.portalserver.logging.LogManager
Get log attributes from a log.
getMaxCachingTime() - Method in class com.iplanet.portalserver.session.Session
Returns the maximum session caching time in minutes.
getMaxIdleTime() - Method in class com.iplanet.portalserver.session.Session
Returns the maximum session idle time in minutes.
getMaxSessionTime() - Method in class com.iplanet.portalserver.session.Session
Returns the maximum session time in minutes.
getName() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
getName() - Method in interface com.iplanet.portalserver.providers.Provider
Get the name of this provider.
getNumberOfStates() - Method in class com.iplanet.portalserver.auth.server.Login
Returns the number of authentication states for this authentication module.
getNumberOfTokens() - Method in class com.iplanet.portalserver.auth.server.Login
Returns the total number of tokens and passwords in the current authentication state.
getNumberOfTokensForState(int) - Method in class com.iplanet.portalserver.auth.server.Login
Returns the total number of tokens and passwords for the given authentication state.
getPersistentCookieOn() - Method in class com.iplanet.portalserver.auth.server.Login
 
getPrivilegeNames() - Method in class com.iplanet.portalserver.profile.Profile
Gets privilege names belong to this profile .
getPrivilegeNames(String) - Method in class com.iplanet.portalserver.profile.Profile
Gets privilege names which match wildchar expression.
getProfile() - Method in class com.iplanet.portalserver.profile.ProfileEvent
Gets the profile corresponding to this notification.
getProfileName() - Method in class com.iplanet.portalserver.profile.Profile
Gets Profile name.
getProfileType() - Method in class com.iplanet.portalserver.profile.Profile
Gets Profile type.
getProperty(String) - Method in class com.iplanet.portalserver.session.Session
Gets the property stored in this session.
getRandomString() - Method in class com.iplanet.portalserver.session.SessionID
This method gets the random String in this object.
getRecMsg() - Method in class com.iplanet.portalserver.logging.LogRecord
The log data or value of a single log record.
getRecType() - Method in class com.iplanet.portalserver.logging.LogRecord
The log type or key of a single log record.
getRefreshTime() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
getRefreshTime() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
getRefreshTime() - Method in interface com.iplanet.portalserver.providers.Provider
Get the refresh time for this provider, in seconds.
getRequestDomain() - Method in class com.iplanet.portalserver.auth.server.Login
 
getResourceBundle(String) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Get the ResourceBundle based on User's locale.
getRow() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
getRow() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
getRow() - Method in interface com.iplanet.portalserver.providers.Provider
Get the row in which this provider should be displayed in.
getSession() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
Get the session object for this provider.
getSession() - Method in class com.iplanet.portalserver.auth.server.Login
 
getSession() - Method in class com.iplanet.portalserver.session.SessionEvent
Gets the session object which emitted this event.
getSession(SessionID) - Static method in class com.iplanet.portalserver.session.Session
Gets a session based on a SessionID object.
getSessionDomain() - Method in class com.iplanet.portalserver.session.SessionID
This method gets the domain where this session belongs to.
getSessionId() - Method in class com.iplanet.portalserver.auth.server.Login
Returns a unique key for this authentication session.
getSessionServer() - Method in class com.iplanet.portalserver.session.SessionID
This method gets the session server name in this object.
getSessionServerPort() - Method in class com.iplanet.portalserver.session.SessionID
This method gets the session server port in this object
getSessionServerProtocol() - Method in class com.iplanet.portalserver.session.SessionID
This method gets the session server protocol in this object
getState() - Method in class com.iplanet.portalserver.util.Debug
Returns one of the five possible values:
getState(boolean) - Method in class com.iplanet.portalserver.session.Session
Returns the state of the session.
getStringProperty(String, String) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Get a string property for the provider.
getStringProperty(String, String, String) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Get a string property for the provider.
getTime() - Method in class com.iplanet.portalserver.profile.ProfileEvent
Gets the notification time.
getTime() - Method in class com.iplanet.portalserver.session.SessionEvent
Gets the time of this event.
getTimeLeft() - Method in class com.iplanet.portalserver.session.Session
Returns the time left for this session in seconds.
getTitle() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
getTitle() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Get the title for this channel.
getTitle() - Method in interface com.iplanet.portalserver.providers.Provider
Get the title of this provider.
getToken() - Method in class com.iplanet.portalserver.auth.server.Login
Returns the user entered value for the first token in the current authentication state.
getToken(int) - Method in class com.iplanet.portalserver.auth.server.Login
Returns the user entered value for the specified token in the current authentication state.
getToken(String) - Method in class com.iplanet.portalserver.auth.server.Login
Returns the user entered value for the specified token in the current authentication state.
getType() - Method in class com.iplanet.portalserver.profile.ProfileException
 
getType() - Method in class com.iplanet.portalserver.profile.ProfileEvent
Gets the notification type.
getType() - Method in class com.iplanet.portalserver.logging.LogException
Get log exception type.
getType() - Method in class com.iplanet.portalserver.session.SessionEvent
Gets the type of this event.
getType() - Method in class com.iplanet.portalserver.session.Session
Returns the session type.
getURL() - Method in class com.iplanet.portalserver.providers.DesktopURL
Get the internally built URL object.
getUserProfile() - Method in class com.iplanet.portalserver.session.Session
Gets the user (client) profile in this session.
getUserProfile(String) - Method in class com.iplanet.portalserver.auth.server.Login
 
getUserSessionProperty(String) - Method in class com.iplanet.portalserver.auth.server.Login
Gets the property from the user session.
getUserTokenId() - Method in class com.iplanet.portalserver.auth.server.Login
This method must be overriden.
getValidSessions() - Method in class com.iplanet.portalserver.session.Session
Gets all valid sessions residing on the same session server as this session object resides from the Session Service.
getValidSessions(String) - Method in class com.iplanet.portalserver.session.Session
Gets all valid sessions from the specified session server.
getWidth() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
getWidth() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
getWidth() - Method in interface com.iplanet.portalserver.providers.Provider
Get the width of this provider.
getWrappedException() - Method in class com.iplanet.portalserver.providers.ProviderWrapperException
Access the wrapped exception.

H

handler - Static variable in class com.iplanet.portalserver.session.SessionNotificationHandler
 
hasBorder() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
hasBorder() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
hasBorder() - Method in interface com.iplanet.portalserver.providers.Provider
Should this provider have a border drawn around it? The desktop calls this method when the front page is drawn.
hasFrame() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
hasFrame() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
hasFrame() - Method in interface com.iplanet.portalserver.providers.Provider
Should this provider have a window frame around it? A frame is defined as the "window" frame containing a title and channel controls that surround provider content.
hashCode() - Method in class com.iplanet.portalserver.session.SessionID
Returns a hash code for this object.
hasHelp() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
hasHelp() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
hasHelp() - Method in interface com.iplanet.portalserver.providers.Provider
Determine if the provider has a help page associated with it.

I

IDLE_TIMEOUT - Static variable in class com.iplanet.portalserver.session.SessionEvent
Session idle time out event
INACTIVE - Static variable in class com.iplanet.portalserver.logging.LogException
log is in inactive state, preventing log submission
INACTIVE - Static variable in class com.iplanet.portalserver.session.Session
 
init() - Method in class com.iplanet.portalserver.auth.server.Login
This method must be overriden.
init(String, Session) - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
init(String, Session) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Initialize the provider.
init(String, Session) - Method in interface com.iplanet.portalserver.providers.Provider
Initializes the provider.
init(String, Session) - Method in class com.iplanet.portalserver.providers.jsp.JSPProvider
Initialize the JSPProvider.
INVALID - Static variable in class com.iplanet.portalserver.session.Session
 
INVALID_LOG_NAME - Static variable in class com.iplanet.portalserver.logging.LogException
log name is in valid
INVALID_SESSION - Static variable in class com.iplanet.portalserver.logging.LogException
invalid session
InvalidEditFormDataException - exception com.iplanet.portalserver.providers.InvalidEditFormDataException.
This exception (or a subclass of) should be thrown from the Provider.processEdit method when there is an error in the data input by the user.
InvalidEditFormDataException() - Constructor for class com.iplanet.portalserver.providers.InvalidEditFormDataException
 
InvalidEditFormDataException(String) - Constructor for class com.iplanet.portalserver.providers.InvalidEditFormDataException
 
isAllowed(String) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Check for access to the named privilege.
isAllowed(String) - Method in class com.iplanet.portalserver.profile.Profile
Checks user privilege.
isAllowed(String, String) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Check for access to the named privilege.
isAllowed(String, String, int) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Check for access to the named privilege.
isAllowed(String, String, int) - Method in class com.iplanet.portalserver.profile.Profile
Checks user privilege.
isAllowed(String, String, String, int) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Check for access to the named privilege.
isAllowedIgnoreCase(String, String, int) - Method in class com.iplanet.portalserver.profile.Profile
Checks user privilege.
isDetachable() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
isDetachable() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
isDetachable() - Method in interface com.iplanet.portalserver.providers.Provider
Determine if the provider can be detached from the Desktop.
isDetached() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
isDetached() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
isDetached() - Method in interface com.iplanet.portalserver.providers.Provider
Determine if the provider is detached from the Desktop.
isEditable() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
isEditable() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
isEditable() - Method in interface com.iplanet.portalserver.providers.Provider
Determine if the provider has an edit page.
isMinimizable() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
isMinimizable() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
isMinimizable() - Method in interface com.iplanet.portalserver.providers.Provider
Determine if the provider can be minimized on the Desktop.
isMinimized() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
isMinimized() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
isMinimized() - Method in interface com.iplanet.portalserver.providers.Provider
Determine if the provider is minimized on the Desktop.
isMovable() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
isMovable() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
isMovable() - Method in interface com.iplanet.portalserver.providers.Provider
Determine if the user can move this channel around on the desktop This method is called by the desktop when the user attempts to change the layout to see if they are allowed to move said channels.
isPresentable() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
Dictates whether the provider is presentable.
isPresentable() - Method in interface com.iplanet.portalserver.providers.Provider
Determine if the provider is presentable based on the client device type.
isRemovable() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
 
isRemovable() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
isRemovable() - Method in interface com.iplanet.portalserver.providers.Provider
Determine if the user can remove this provider from the desktop This method is called by the desktop when it draws the front page.

J

JSPProvider - class com.iplanet.portalserver.providers.jsp.JSPProvider.
A JSPProvider is a content provider that can use JavaServer Pages (JSPs) to create the content for a channel on the desktop.
JSPProvider() - Constructor for class com.iplanet.portalserver.providers.jsp.JSPProvider
Construct a JSPProvider.

L

LIST_ACCESS_DENIED - Static variable in class com.iplanet.portalserver.logging.LogException
log listing privilege is denied
LIST_NOT_EXISTS - Static variable in class com.iplanet.portalserver.logging.LogException
log list does not exist
list() - Method in class com.iplanet.portalserver.logging.LogManager
Get all the existing logs (history segments not included) from the system.
list(String) - Method in class com.iplanet.portalserver.logging.LogManager
Obtain a specific log segment list.
load() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
This method has no effect.
load() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Load properties from the profile store.
load() - Method in interface com.iplanet.portalserver.providers.Provider
Load persistently stored attributes for this provider.
loadAttributes(Set) - Method in class com.iplanet.portalserver.profile.Profile
Load attribute values based on attribute names.
loadPrivileges(Set) - Method in class com.iplanet.portalserver.profile.Profile
Load privilege values based on privilege names.
loadProperties(String) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Load properties into provider.
LoadPropertiesException - exception com.iplanet.portalserver.providers.LoadPropertiesException.
This exception is thrown from ProfileProviderAdapter.loadProperties() when there was an error loading the named properties.
LoadPropertiesException() - Constructor for class com.iplanet.portalserver.providers.LoadPropertiesException
 
LoadPropertiesException(String) - Constructor for class com.iplanet.portalserver.providers.LoadPropertiesException
 
LOCATION - Static variable in class com.iplanet.portalserver.logging.LogManager
log location
LOG_HANDLER_ERROR - Static variable in class com.iplanet.portalserver.logging.LogException
log handler error
LOG_NOT_FOUND - Static variable in class com.iplanet.portalserver.logging.LogException
no such log exists
LogException - exception com.iplanet.portalserver.logging.LogException.
The applications may encounter errors when they are denied for a log access because they don't have the access privileges or when they do not have a valid session.
LogException() - Constructor for class com.iplanet.portalserver.logging.LogException
Create a log exception.
LogException(String) - Constructor for class com.iplanet.portalserver.logging.LogException
Create a log exception.
LogException(String, int) - Constructor for class com.iplanet.portalserver.logging.LogException
Create a log exception.
Login - class com.iplanet.portalserver.auth.server.Login.
An abstract class used for writing pluggable athentication modules.
Login() - Constructor for class com.iplanet.portalserver.auth.server.Login
Login constructor.
LoginException - exception com.iplanet.portalserver.auth.server.LoginException.
Exception that is thrown when the user entered tokens fail the modules authentication.
LoginException() - Constructor for class com.iplanet.portalserver.auth.server.LoginException
 
LoginException(String) - Constructor for class com.iplanet.portalserver.auth.server.LoginException
 
LogManager - class com.iplanet.portalserver.logging.LogManager.
This class provides the logging access methods for applications so that the applications can create, retrieve, submit, delete log information.
LogManager(Session) - Constructor for class com.iplanet.portalserver.logging.LogManager
 
LogManager(SessionID) - Constructor for class com.iplanet.portalserver.logging.LogManager
 
LogManager(SessionID, String) - Constructor for class com.iplanet.portalserver.logging.LogManager
 
LogManager(Session, String) - Constructor for class com.iplanet.portalserver.logging.LogManager
 
LOGOUT - Static variable in class com.iplanet.portalserver.session.SessionEvent
Session logout event
logout() - Method in class com.iplanet.portalserver.auth.server.Login
 
logout() - Method in class com.iplanet.portalserver.session.Session
Logout a session.
LogRecord - class com.iplanet.portalserver.logging.LogRecord.
 
LogRecord(String, String) - Constructor for class com.iplanet.portalserver.logging.LogRecord
A log record (key-value pair) information to a log.

M

MAX_TIMEOUT - Static variable in class com.iplanet.portalserver.session.SessionEvent
Session maximum time out event
MAXFILESIZE - Static variable in class com.iplanet.portalserver.logging.LogManager
log maximum file size, with minimum 100,000 bytes
MESSAGE - Static variable in class com.iplanet.portalserver.util.Debug
This state enables debugging of messages, warnings and errors.
message(String) - Method in class com.iplanet.portalserver.util.Debug
Prints messages only when the debug state is either DEBUG.MESSAGE or Debug.ON.
message(String, Throwable) - Method in class com.iplanet.portalserver.util.Debug
Prints debug and exception messages only when the debug state is either DEBUG.MESSAGE or Debug.ON.
messageEnabled() - Method in class com.iplanet.portalserver.util.Debug
Checks if message debugging is enabled.

N

NEW - Static variable in class com.iplanet.portalserver.profile.Profile
New attribute value i.e replace old value
NO_SUCH_SEGMENT_EXISTS - Static variable in class com.iplanet.portalserver.logging.LogException
no such log segment exists
NULL_LOCATION - Static variable in class com.iplanet.portalserver.logging.LogException
log jdbc driver null location
NULL_POINTER - Static variable in class com.iplanet.portalserver.logging.LogException
log jdbc null pointer
NUMHISTORYFILE - Static variable in class com.iplanet.portalserver.logging.LogManager
number of history log

O

OFF - Static variable in class com.iplanet.portalserver.util.Debug
flags the disabled debug state.
ON - Static variable in class com.iplanet.portalserver.util.Debug
flags the enabled debug state for warnings, errors and messages.

P

PREFIX - Static variable in class com.iplanet.portalserver.profile.Profile
Prefix matching
printStackTrace() - Method in class com.iplanet.portalserver.providers.ProviderWrapperException
 
printStackTrace(PrintStream) - Method in class com.iplanet.portalserver.providers.ProviderWrapperException
 
printStackTrace(PrintWriter) - Method in class com.iplanet.portalserver.providers.ProviderWrapperException
 
process(Vector) - Method in class com.iplanet.portalserver.session.SessionNotificationHandler
 
processEdit(HttpServletRequest, HttpServletResponse) - Method in class com.iplanet.portalserver.providers.ProviderAdapter
Call processEdit(Map) with the request parameters.
processEdit(HttpServletRequest, HttpServletResponse) - Method in interface com.iplanet.portalserver.providers.Provider
Process the edit form for this provider.
processEdit(HttpServletRequest, HttpServletResponse) - Method in class com.iplanet.portalserver.providers.jsp.JSPProvider
Perform the provider's edit page processing by executing a JSP.
processEdit(Map) - Method in class com.iplanet.portalserver.providers.ProviderAdapter
This method has no effect.
processEdit(Map) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
processEdit(Map) - Method in interface com.iplanet.portalserver.providers.Provider
 
processEdit(Map) - Method in class com.iplanet.portalserver.providers.jsp.JSPProvider
Perform the provider's edit page processing by executing a JSP.
processNotification(SessionNotification) - Method in class com.iplanet.portalserver.session.SessionNotificationHandler
 
Profile - class com.iplanet.portalserver.profile.Profile.
Profile class provides common methods to get/set/delete profile attributes.
PROFILE_CHANGE - Static variable in class com.iplanet.portalserver.profile.ProfileEvent
 
PROFILE_CREATE - Static variable in class com.iplanet.portalserver.profile.ProfileEvent
 
PROFILE_DELETE - Static variable in class com.iplanet.portalserver.profile.ProfileEvent
 
PROFILE_ERROR - Static variable in class com.iplanet.portalserver.logging.LogException
log profile error
profileChanged(ProfileEvent) - Method in interface com.iplanet.portalserver.profile.ProfileListener
This method will be invoked when a profile notification arrives.
ProfileEvent - class com.iplanet.portalserver.profile.ProfileEvent.
ProfileEvent class represents profile event notification.
ProfileException - exception com.iplanet.portalserver.profile.ProfileException.
This is generic profile service exception.
ProfileException(String) - Constructor for class com.iplanet.portalserver.profile.ProfileException
 
ProfileException(String, int) - Constructor for class com.iplanet.portalserver.profile.ProfileException
 
ProfileException(Throwable) - Constructor for class com.iplanet.portalserver.profile.ProfileException
 
ProfileException(Throwable, int) - Constructor for class com.iplanet.portalserver.profile.ProfileException
 
ProfileListener - interface com.iplanet.portalserver.profile.ProfileListener.
The ProfileListener interface needs to be implemented by applications in order to receive profile notifications.
ProfileProviderAdapter - class com.iplanet.portalserver.providers.ProfileProviderAdapter.
This class implements the Provider interface and provides default implementations for its methods using the iPS Profile Service.
ProfileProviderAdapter() - Constructor for class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
ProfileProviderException - exception com.iplanet.portalserver.providers.ProfileProviderException.
This exception encapsulates a ProfileException.
ProfileProviderException(String, ProfileException) - Constructor for class com.iplanet.portalserver.providers.ProfileProviderException
Constructor.
Provider - interface com.iplanet.portalserver.providers.Provider.
Provider defines the interface for implementing Content Providers (provider).
ProviderAdapter - class com.iplanet.portalserver.providers.ProviderAdapter.
This class provides default implementations for the Provider API.
ProviderAdapter() - Constructor for class com.iplanet.portalserver.providers.ProviderAdapter
 
ProviderException - exception com.iplanet.portalserver.providers.ProviderException.
This exception is a generic superclass for all provider related exceptions.
ProviderException() - Constructor for class com.iplanet.portalserver.providers.ProviderException
 
ProviderException(String) - Constructor for class com.iplanet.portalserver.providers.ProviderException
 
ProviderWrapperException - exception com.iplanet.portalserver.providers.ProviderWrapperException.
This class wraps one exception within another and provides access to the original exception.
ProviderWrapperException(String, Exception) - Constructor for class com.iplanet.portalserver.providers.ProviderWrapperException
Create a new wrapper exception.

R

REACTIVATION - Static variable in class com.iplanet.portalserver.session.SessionEvent
Session reactivation event
READ_ACCESS_DENIED - Static variable in class com.iplanet.portalserver.logging.LogException
log retrieval privilege is denied
READ_ERROR - Static variable in class com.iplanet.portalserver.logging.LogException
log Retrieval error
READ_EXCEEDS_MAX - Static variable in class com.iplanet.portalserver.logging.LogException
log retrieval size (in bytes) exceeds the maximum allowed
read(String) - Method in class com.iplanet.portalserver.logging.LogManager
Read log strings from a log.
read(String, String) - Method in class com.iplanet.portalserver.logging.LogManager
Retrieve log strings from a log with a query.
readLogRecord(String) - Method in class com.iplanet.portalserver.logging.LogManager
Read log records from a log.
readLogRecord(String, String) - Method in class com.iplanet.portalserver.logging.LogManager
Retrieve log records from a log with a query.
READSIZE - Static variable in class com.iplanet.portalserver.logging.LogManager
log read size, with minimum 3,000 bytes
refresh(boolean) - Method in class com.iplanet.portalserver.session.Session
Gets the latest session from session server and updates the local cache of this session.
REGULAR - Static variable in class com.iplanet.portalserver.profile.Profile
Regular matching i.e match all
removeProfileListener(ProfileListener) - Method in class com.iplanet.portalserver.profile.Profile
Removes specified profile listener so that it doesn't receive profile change events from this profile.
ROLE - Static variable in class com.iplanet.portalserver.profile.Profile
Rrole profile type

S

Session - class com.iplanet.portalserver.session.Session.
The Session class represents a session.
SESSION_CREATION - Static variable in class com.iplanet.portalserver.session.SessionEvent
Session creation event
SESSION_SERVICE - Static variable in class com.iplanet.portalserver.session.Session
 
sessionChanged(SessionEvent) - Method in interface com.iplanet.portalserver.session.SessionListener
This method will be invoked when a session event arrives.
SessionEvent - class com.iplanet.portalserver.session.SessionEvent.
The SessionEvent class represents a session event.
SessionException - exception com.iplanet.portalserver.session.SessionException.
A SessionException is thrown if the Naming Service can not find a URL for the session service.
SessionException(String) - Constructor for class com.iplanet.portalserver.session.SessionException
Constructs an instance of the SessionException class.
SessionException(Throwable) - Constructor for class com.iplanet.portalserver.session.SessionException
Constructs an instance of the SessionException class.
SessionID - class com.iplanet.portalserver.session.SessionID.
The SessionID class is used to indentify a Session object.
SessionID(HttpServletRequest) - Constructor for class com.iplanet.portalserver.session.SessionID
Constructs a SessionID object based on a HttpServletRequest object.
SessionID(String) - Constructor for class com.iplanet.portalserver.session.SessionID
Constructs a SessionID object based on a String.
SessionListener - interface com.iplanet.portalserver.session.SessionListener.
The SessionListener interface needs to be implemented by applications in order to receive session events.
SessionNotificationHandler - class com.iplanet.portalserver.session.SessionNotificationHandler.
 
SessionNotificationHandler(Hashtable, Hashtable) - Constructor for class com.iplanet.portalserver.session.SessionNotificationHandler
 
setAttribute(String, Enumeration, int) - Method in class com.iplanet.portalserver.profile.Profile
Sets attribute value based on operation.
setAttributeString(String, String, int) - Method in class com.iplanet.portalserver.profile.Profile
Sets value of string type attribute.
setAuthLevel(int) - Method in class com.iplanet.portalserver.auth.server.Login
Attempt to set the AuthLevel for this session.
setColumn(int) - Method in class com.iplanet.portalserver.providers.ProviderAdapter
This method has no effect.
setColumn(int) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
setColumn(int) - Method in interface com.iplanet.portalserver.providers.Provider
Sets the column for this provider to be displayed in.
setDebug() - Method in class com.iplanet.portalserver.util.Debug
Enables or disables degbugging based on the value of debug attribute, ips.debug, in the platform config file, /etc/opt/SUNWips/platform.conf.
setDebug(Debug, String) - Method in class com.iplanet.portalserver.session.Session
Enables or disables degbugging/logging based on the value of debug attributes inside the application profile, which is accessible from the Session, sess.
setDebug(int) - Method in class com.iplanet.portalserver.util.Debug
Sets the debug capabilities based on the values of the debugType argument.
setDebug(String) - Method in class com.iplanet.portalserver.util.Debug
Sets the debug capabilities based on the values of the debugType argument.
setDefaultURL(String) - Method in class com.iplanet.portalserver.auth.server.Login
Sets the the default URL for the user.
setDetached(boolean) - Method in class com.iplanet.portalserver.providers.ProviderAdapter
This method has no effect.
setDetached(boolean) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
setDetached(boolean) - Method in interface com.iplanet.portalserver.providers.Provider
Set the detached state of this provider.
setDomain(String) - Method in class com.iplanet.portalserver.auth.server.Login
 
setListProperty(String, String, Vector) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Set a list property for the provider.
setListProperty(String, Vector) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Set a list property for the provider.
setLocalListProperty(String, String, Vector) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Set a list property for the provider.
setLocalListProperty(String, Vector) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Set a list property for the provider.
setLocalStringProperty(String, String) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Set a string property for the provider.
setLocalStringProperty(String, String, String) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Set a string property for the provider.
setLogAttrs(String, Hashtable) - Method in class com.iplanet.portalserver.logging.LogManager
Set log attributes for a log.
setMinimized(boolean) - Method in class com.iplanet.portalserver.providers.ProviderAdapter
This method has no effect.
setMinimized(boolean) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
setMinimized(boolean) - Method in interface com.iplanet.portalserver.providers.Provider
Set the minimized state of this provider.
setNextScreen(int) - Method in class com.iplanet.portalserver.auth.server.Login
 
setPersistentCookieOn() - Method in class com.iplanet.portalserver.auth.server.Login
Attempt to set the Persistent Cookie for this session.
setProperty(String, String) - Method in class com.iplanet.portalserver.session.Session
Sets a property for this session.
setReplaceText(int, int, String) - Method in class com.iplanet.portalserver.auth.server.Login
 
setReplaceText(int, String) - Method in class com.iplanet.portalserver.auth.server.Login
The tokens and passwords have text descriptions for each authentication page.
setReplaceText(int, String[]) - Method in class com.iplanet.portalserver.auth.server.Login
Same as setReplaceText(), but allows replacement of of multiple tokens.
setRow(int) - Method in class com.iplanet.portalserver.providers.ProviderAdapter
This method has no effect.
setRow(int) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
 
setRow(int) - Method in interface com.iplanet.portalserver.providers.Provider
Sets the row for this provider to be displayed in.
setStringProperty(String, String) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Set a string property for the provider.
setStringProperty(String, String, String) - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Set a string property for the provider.
setUserSessionProperty(String, String) - Method in class com.iplanet.portalserver.auth.server.Login
Sets a property in the user session.
SQL_ERROR - Static variable in class com.iplanet.portalserver.logging.LogException
log SQL error
STATUS - Static variable in class com.iplanet.portalserver.logging.LogManager
log status
store() - Method in class com.iplanet.portalserver.providers.ProviderAdapter
This method has no effect.
store() - Method in class com.iplanet.portalserver.providers.ProfileProviderAdapter
Store properties to the profile store.
store() - Method in interface com.iplanet.portalserver.providers.Provider
Persistently store attributes for this provider.
store(boolean) - Method in class com.iplanet.portalserver.profile.Profile
Stores profile data in the profile database.
SUFFIX - Static variable in class com.iplanet.portalserver.profile.Profile
Suffix matching

T

toString() - Method in class com.iplanet.portalserver.providers.ProviderWrapperException
 
toString() - Method in class com.iplanet.portalserver.providers.DesktopURL
Get the URL as a String.
toString() - Method in class com.iplanet.portalserver.session.SessionID
This method returns the encrypted session string.
TYPE - Static variable in class com.iplanet.portalserver.logging.LogManager
log type, ie, plain text or JDBC
TYPE_ERROR - Static variable in class com.iplanet.portalserver.logging.LogException
log type error

U

UnknownEditTypeException - exception com.iplanet.portalserver.providers.UnknownEditTypeException.
This exception may be thrown from Provider.getEditType() if an unknown or undefined edit type is encountered.
UnknownEditTypeException() - Constructor for class com.iplanet.portalserver.providers.UnknownEditTypeException
 
UnknownEditTypeException(String) - Constructor for class com.iplanet.portalserver.providers.UnknownEditTypeException
 
USER - Static variable in class com.iplanet.portalserver.profile.Profile
User profile type
USER_SESSION - Static variable in class com.iplanet.portalserver.session.Session
 

V

VALID - Static variable in class com.iplanet.portalserver.session.Session
 
validate() - Method in class com.iplanet.portalserver.auth.server.Login
This method must be overriden.

W

WARNING - Static variable in class com.iplanet.portalserver.util.Debug
flags the state where warning debugging is enabled, but message debugging is disabled.
warning(String) - Method in class com.iplanet.portalserver.util.Debug
Prints warning messages only when debug level is greater than DEBUG.ERROR.
warning(String, Throwable) - Method in class com.iplanet.portalserver.util.Debug
Prints warning messages only when debug level is greater than DEBUG.ERROR.
warningEnabled() - Method in class com.iplanet.portalserver.util.Debug
Checks if warning debugging is enabled.
WIDTH_FULL_BOTTOM - Static variable in interface com.iplanet.portalserver.providers.Provider
Provider can be displayed in a "full" frame at the bottom.
WIDTH_FULL_TOP - Static variable in interface com.iplanet.portalserver.providers.Provider
Provider can be displayed in a "full" frame at the top.
WIDTH_THICK - Static variable in interface com.iplanet.portalserver.providers.Provider
Provider can be displayed in a "thick" frame.
WIDTH_THIN - Static variable in interface com.iplanet.portalserver.providers.Provider
Provider can be displayed in a "thin" frame.
WRITE_ACCESS_DENIED - Static variable in class com.iplanet.portalserver.logging.LogException
log submition privilege is denied
WRITE_ERROR - Static variable in class com.iplanet.portalserver.logging.LogException
log submission error
write(LogRecord, String) - Method in class com.iplanet.portalserver.logging.LogManager
Write a log record (key-value pair) information to a log.

A C D E F G H I J L M N O P R S T U V W