Sun ONE logo     Previous     Contents     Index     Next     
Sun ONE Portal Server 6.0 Migration Guide



Appendix C       Public API Changes Between Sun ONE Portal Server 3.0 and Sun ONE Portal Server 6.0



Note All instances of the Sun™ ONE Portal Server 3.0 product refer to what were formerly known as the iPlanet™ Portal Server 3.0, Service Pack 3a and iPlanet™ Portal Server 3.0, Service Pack 4 products.


This appendix provides information on public API changes between Sun ONE Portal Server 3.0 and Sun™ ONE Portal Server 6.0 that you need to know for migration purposes. The tables in this appendix are not meant to be a replacement for the javadocs.

Table C-1 shows the API changes you need to know to migrate Sun ONE Portal Server 3.0 Session to iPlanet™ Directory Server Access Management Edition 5.1 SSOToken. This three-column table shows the class and method signature in Sun ONE Portal Server 3.0 in the first column. The second column shows the application migration class method signature in Sun ONE Portal Server 6.0. The third column shows the provider migration class method signature in Sun ONE Portal Server 6.0.


Table C-1    Migrating Sun ONE Portal Server 3.0 Session to iPlanet Directory Server Access Management Edition 5.1 SSOToken 

Class/Method Signature in Sun ONE Portal Server 3.0

Application Migration

Class Method Signature in Sun ONE Portal Server 6.0

Provider Migration

Class Method Signature in Sun ONE Portal Server 6.0

com.iplanet.portalserver.auth.server.Login  

com.iplanet.authentication.spi.AuthenticationModule

 

com.sun.portal.providers.context.ProviderContext  

Properties getAllTokenNames()  

Properties getAllTokenNames()  

 

String [] getAllTokens()  

String [] getAllTokens()  

 

String [] getAllTokensForState(int stateNumber)  

String [] getAllTokensForState(int stateNumber)  

 

Profile getApplicationProfile(String name)  

AMStoreConnection.getSchema

and

AMSchema.getAttributeDefaults  

 

int getAuthLevel()  

int getAuthLevel()  

 

int getCurrentState()  

int getCurrentState()  

 

Profile getDomainProfile(String name)  

AMStoreConnection.getOrganization()  

 

HttpServletRequest getHttpServletRequest()  

HttpServletRequest getHttpServletRequest()  

 

HttpServletResponse getHttpServletResponse()  

HttpServletResponse getHttpServletResponse()  

 

String getLocale()  

String getLocale()  

Locale getLocale()  

int getNumberofStates()  

int getNumberofStates()  

 

int getNumberofTokens()  

int getNumberofTokens()  

 

int getNumberofTokensForState()  

int getNumberofTokensForState()  

 

boolean getPersistentCookieOn()  

boolean getPersistentCookieOn()  

 

String getRequestDomain  

String getRequestOrg()  

 

Session getSession()  

SSOToken getSSOSession()  

 

String getSessionId()  

String getSessionId()  

String getSessionID()  

String getToken()  

String getToken()  

 

String getToken(String name)  

String getToken(String name)  

 

Profile getUserProfile (String name)  

AMUser getUserProfile(String userDN)  

 

String getUserSessionProperty(String name)  

String getUserSessionProperty(String name)  

Object getSessionProperty(String name)  

abstract String getUserTokenID()  

abstract String getUserTokenID()  

 

abstract void init()  

abstract void init()  

 

void logout()  

void logout()  

 

int setAuthLevel (int auth_level)  

int setAuthLevel (int auth_level)  

 

void setDefaultURL(String url)  

void setDefaultURL(String url)  

 

void setDomain (String domain)  

void setOrg(String orgDN)  

 

void setNextScreen(int num)  

void setNextScreen(int num)  

 

void setPersistantCookieOn()  

void setPersistantCookieOn()  

 

void setReplaceText(int screenNumber, int token, String text)  

void setReplaceText(int screenNumber, int token, String text)  

 

void setReplaceText(int token, String text)  

void setReplaceText(int token, String text)  

 

void setReplaceText(int token, String[] text)  

void setReplaceText(int token, String[] text)  

 

void setUserSessionProperty(String name, String value)  

void setUserSessionProperty(String name, String value)  

void setSessionProperty(String name, Object val)  

abstract void validate()  

abstract void validate()  

 

 

 

 

com.iplanet.portalserver.auth.server.LoginException  

com.iplanet.authentication.spi.AuthenticationException  

 

 

com.iplanet.authentication.spi.InvalidPasswordException  

 

 

 

 

com.iplanet.portalserver.session.SessionListener  

com.iplanet.sso.SSOTokenListener  

 

void sessionChanged(SessionEvent evt)  

void ssoTokenChanged(SSOTokenEvent evt)  

 

com.iplanet.portalserver.session.Session  

com.iplanet.sso.SSOToken  

 

void addSessionListener (SessionListener listener)  

void addSSOTokenListener(SSOTokenListener listener)  

 

void addSessionListenerOnAllSession(SessionListener listener)  

void addSSOTokenListener(SSOTokenListener listener)  

 

void addSessionListenerOnAllSession(String server, SessionListener listener)  

void addSSOTokenListener(SSOTokenListener listener)  

 

String encodeURL(HttpServletResponse res, String url)  

String encodeURL(String url)  

String encodeURL(String url)  

String encodeURL(String url)  

String encodeURL(String url)  

 

Profile getAppProfile (String name)  

use the SSOToken to create an AMStoreConnection and then call AMStoreConnection.getSchema  

 

String getClientDomain ()  

use the SSOToken to create an AMStoreConnection and then call AMStoreConnection.getOrganization  

 

String getClientID()  

use com.iplanet.services.cdm.Client for client data and use getClientType to retrieve client type  

String getClientType()  

boolean getCookieSupport()  

boolean getPersistentCookieOn()  

 

int getEventType()  

Any programs that use this API in Sun ONE Portal Server 3.0 have a race condition because there is no way to ensure that events are not missed. Replace use of this method with an SSOTokenListener object.  

 

SessionID getID()  

java.lang.String getSessionId()  

 

long getIdleTime()  

long getIdleTime()  

 

long getMaxCachingTime()  

long getMaxCachingTime()  

 

long getMaxIdleTime()  

long getMaxIdleTime()  

 

long getMaxSessionTime()  

long getMaxSessionTime()  

 

String getProperty(String name)  

String getProperty(String name)  

 

static Session getSession(SessionID sid)  

SSOToken getSSOSession()  

 

int getState(boolean reset)  

int getCurrentState()  

 

long getTimeLeft()  

long getTimeLeft()  

 

int getType()  

All publicly accessible sessions in Sun ONE Portal Server 3.0 have a session type of Session.USER_SESSION. So any application code that uses this method can assume that the method only returns Session.USER_SESSION.  

 

Profile getUserProfile()  

AMUser getUserProfile(java.lang.String userDN) throws AuthenticationException  

 

Vector getValidSessions()  

iPlanet Directory Server Access Management Edition 5.1 does not provide functionality for session (or SSO token) management. This is a planned feature for a future release.  

 

Vector getValidSessions(String server)  

iPlanet Directory Server Access Management Edition 5.1 does not provide functionality for session (or SSO token) management. This is a planned feature for a future release.  

 

void logout()  

void logout()  

 

void setDebug(Debug debug, String profileName)  

This method does the following:

Profile p = getAppProfile(profileName);

debug.setDebug(p.getAttributeString(profileName + "-debug"));

See the other entries in the table for the equivalents of getAppProfile, getAttributeString, and setDebug.  

 

void setProperty(String name, String value)  

void setProperty(String name, String value)  

 

 

 

 

com.iplanet.portalserver.session.SessionEvent  

com.iplanet.sso.SSOTokenManager  

 

void destroySession(Session session)  

void destroyToken(SSOToken token)  

 

void refresh(boolean reset)  

void refreshSession(SSOToken token)  

 

 

 

 

com.iplanet.portalserver.session.SessionEvent  

com.iplanet.sso.SSOTokenEvent  

 

Session getSession()  

SSOToken getToken()  

 

long getTime()  

long getTime()  

 

int getType()  

int getType()  

 

 

 

 

com.iplanet.portalserver.session.SessionID  

com.iplanet.sso.SSOTokenID  

 

boolean equals(Object object)  

boolean equals(Object object)  

 

boolean getCookieMode()  

use com.iplanet.authentication.spi and then boolean getPersistentCookieOn()  

 

String getRandomString()  

The structure of the SSO token cookie value has changed in iPlanet Directory Server Access Management Edition 5.1, hiding the internals of its structure from the application. If this value is needed, the SSOToken.setProperty method can be used to save this information and retrieve it later.  

 

String getSessionDomain()  

The structure of the SSO token cookie value has changed in iPlanet Directory Server Access Management Edition 5.1, hiding the internals of its structure from the application. If this value is needed, the SSOToken.setProperty method can be used to save this information and retrieve it later.  

 

String getSessionServer()  

The structure of the SSO token cookie value has changed in iPlanet Directory Server Access Management Edition 5.1, hiding the internals of its structure from the application. If this value is needed, the SSOToken.setProperty method can be used to save this information and retrieve it later.  

 

String getSessionServerPort()  

The structure of the SSO token cookie value has changed in iPlanet Directory Server Access Management Edition 5.1, hiding the internals of its structure from the application. If this value is needed, the SSOToken.setProperty method can be used to save this information and retrieve it later.  

 

String getSessionServerProtocol()  

The structure of the SSO token cookie value has changed in iPlanet Directory Server Access Management Edition 5.1, hiding the internals of its structure from the application. If this value is needed, the SSOToken.setProperty method can be used to save this information and retrieve it later.  

 

int hashCode()  

int hashCode()  

 

String toString()  

String toString()  

 

 

 

 

com.iplanet.portalserver.session.SessionNotificationHandler  

No similiar class  

 

 

 

 

com.iplanet.portalserver.session.SessionException  

com.iplanet.sso.SSOException  

 

You can find samples in BaseDir/SUNWam/samples/authentication and BaseDir/SUNWam/samples/sso.

Table C-2 shows the API changes you need to know to migrate the Sun ONE Portal Server 3.0 profile to iPlanet Directory Server Access Management Edition 5.1 user management classes and service management classes. This three-column table shows the method signature in Sun ONE Portal Server 3.0 in the first column. The second column shows the application migration class method signature in Sun ONE Portal Server 6.0. The third column shows the provider migration class method signature in Sun ONE Portal Server 6.0.


Table C-2    Migrating the Sun ONE Portal Server 3.0 Profile to iPlanet Directory Server Access Management Edition 5.1 User Management Classes and Service Management Classes 

Method Signature in Sun ONE Portal Server 3.0

Application Migration

Class Method Signature in Sun ONE Portal Server 6.0

Provider Migration

Class Method Signature in Sun ONE Portal Server 6.0

com.iplanet.portalserver.profile.ProfileListener  

com.iplanet.am.sdk.AMEventListener  

 

void profileChanged(ProfileEvent notif)  

void objectChanged(AMEvent event)  

 

com.iplanet.portalserver.profile.Profile  

com.iplanet.am.sdk.AMObject  

com.sun.portal.providers.context.ProviderContext  

java.lang.String getAttributeString(java.lang.String name) throws ProfileException  

java.lang.String getStringAttribute(java.lang.String attributeName) throws AMException, SSOException  

String getStringAttribute(String name)  

java.util.Enumeration getAttribute(java.lang.String name) throws ProfileException  

java.util.Set getAttribute(java.lang.String attributeName) throws AMException, SSOException  

Map getCollectionProperty(String channel, String name) throws ProviderContextException

or

Object getProperty(String channel, String name) throws ProviderContextException  

java.util.Hashtable getAttributes() throws ProfileException  

java.util.Map getAttributes() throws AMException, SSOException  

 

java.util.Hashtable getAttributes(java.lang.String wildchar) throws ProfileException  

java.util.Map getAttributes(java.util.Set attributeNames) throws AMException, SSOException  

 

void setAttributeString(java.lang.String name, java.lang.String value, int operation) throws ProfileException  

void setStringAttribute(java.lang.String attributeName, java.lang.String value) throws AMException, SSOException  

setProperty(String channel, String key, Object val) throws ProviderContextException

or

void setCollectionProperty(String channel, String key, Map val) throws ProviderContextException  

void setAttribute(java.lang.String name, java.util.Enumeration value, int operation) throws ProfileException  

void setAttributes(java.util.Map attributes) throws AMException, SSOException  

 

void delAttribute(java.lang.String name) throws ProfileException  

void removeAttributes(java.util.Set attributes) throws AMException, SSOException  

 

void delAttributes(java.lang.String wildchar) throws ProfileException  

void removeAttributes(java.util.Set attributes) throws AMException, SSOException  

 

void addProfileListener(ProfileListener l)  

void addEventListener(AMEventListener listener) throws SSOException  

 

void removeProfileListener(ProfileListener l)  

public void removeEventListener(AMEventListener listener)  

 

void store(boolean force) throws ProfileException  

void store()throws AMException, SSOException  

 

boolean isAllowed(java.lang.String privilege) throws ProfileException  

Call getAttribute on a boolean attribute.

 

 

boolean isAllowed(java.lang.String privilege, java.lang.String value, int match) throws ProfileException  

Call getAttribute on one or more attributes and perform the appropriate matching against the attribute value. The policy interface being made public is planned for a future release.  

 

boolean isAllowedIgnoreCase(java.lang.String privilege, java.lang.String value, int match) throws ProfileException  

Call getAttribute on one or more attributes and perform the appropriate matching against the attribute value. The policy interface being made public is planned for a future release.  

 

void loadPrivileges(java.util.Set privilegeNames) throws ProfileException  

AMTemplate createPolicyTemplate(java.lang.String serviceName,java.util.Map attributes) throws java.lang.UnsupportedOperationException, AMException, SSOException  

 

java.util.Enumeration getPrivilegeNames() throws ProfileException  

java.util.Map getPolicy(java.lang.String serviceName) throws java.lang.UnsupportedOperationException, AMException, SSOException  

 

java.util.Enumeration getPrivilegeNames(java.lang.String wildchar) throws ProfileException  

java.util.Map getPolicy(java.lang.String serviceName) throws java.lang.UnsupportedOperationException, AMException, SSOException  

 

java.lang.String getProfileName()  

java.lang.String getDN()  

 

int getProfileType()  

Use instanceof to determine whether the object being operated on is AMUser, AMRole, AMOrganization, or AMSchema.  

 

com.iplanet.portalserver.profile.ProfileEvent  

com.iplanet.am.sdk.AMEvent  

 

Profile getProfile()  

java.lang.String getSourceDN()  

 

int getType()  

int getEventType()  

 

long getTime()  

No equivalent. If it is necessary for the application to communicate the times for profile modification events, this can be done using an out-of-band mechanism.  

 

com.iplanet.portalserver.profile.ProfileException  

com.iplanet.am.sdk.AMException  

com.sun.portal.providers.context.ProviderContextException  

int getType()  

java.lang.String getErrorCode()  

 

You can find samples in BaseDir/SUNWam/samples/sdk.

Table C-3 shows the API changes you need to know to migrate Sun ONE Portal Server 3.0 logging to iPlanet Directory Server Access Management Edition 5.1 logging APIs. This three-column table shows the method signature in Sun ONE Portal Server 3.0 in the first column. The second column shows the method signature in Sun ONE Portal Server 6.0. The third column shows the provider migration class method signature in Sun ONE Portal Server 6.0.


Table C-3    Migrating Sun ONE Portal Server 3.0 Logging to iPlanet Directory Server Access Management Edition 5.1 Logging APIs 

Method Signature in Sun ONE Portal Server 3.0

Method Signature in Sun ONE Portal Server 6.0

Provider Migration

Class Method Signature in Sun ONE Portal Server 6.0

com.iplanet.portalserver.logging.LogManager  

com.iplanet.log.LogManager  

 

LogManager(Session sess)  

LogManager(SSOToken token)  

 

LogManager(SessionID sid)  

Use the SSOToken version of the constructor.  

 

LogManager(SessionID sid, java.lang.String server)  

Use the SSOToken version of the constructor.  

 

LogManager(Session sess, java.lang.String server)  

Use the SSOToken version of the constructor.  

 

void create(java.lang.String logName)  

void create(java.lang.String logName)  

 

void delete(java.lang.String logName)  

Deleting a log file via the API is no longer supported.  

 

java.util.Hashtable getLogAttrs(java.lang.String logName)  

The log APIs for reading logs and setting or getting log attributes do not exist in iPlanet Directory Server Access Management Edition 5.1. In the future, the plan is for Sun ONE products to migrate towards the use of the standard Java 1.4 logging APIs. Use of these proprietary log APIs is discouraged.  

 

java.util.Vector list()  

The log APIs for reading logs and setting or getting log attributes do not exist in iPlanet Directory Server Access Management Edition 5.1. In the future, the plan is for Sun ONE products to migrate towards the use of the standard Java 1.4 logging APIs. Use of these proprietary log APIs is discouraged.  

 

java.util.Vector list(java.lang.String logName)  

The log APIs for reading logs and setting or getting log attributes do not exist in iPlanet Directory Server Access Management Edition 5.1. In the future, the plan is for Sun ONE products to migrate towards the use of the standard Java 1.4 logging APIs. Use of these proprietary log APIs is discouraged.  

 

java.util.Vector read(java.lang.String logName)  

The log APIs for reading logs and setting or getting log attributes do not exist in iPlanet Directory Server Access Management Edition 5.1. In the future, the plan is for Sun ONE products to migrate towards the use of the standard Java 1.4 logging APIs. Use of these proprietary log APIs is discouraged.  

 

java.util.Vector read(java.lang.String logName, java.lang.String query)  

The log APIs for reading logs and setting or getting log attributes do not exist in iPlanet Directory Server Access Management Edition 5.1. In the future, the plan is for Sun ONE products to migrate towards the use of the standard Java 1.4 logging APIs. Use of these proprietary log APIs is discouraged.  

 

java.util.List readLogRecord(java.lang.String logName)  

The log APIs for reading logs and setting or getting log attributes do not exist in iPlanet Directory Server Access Management Edition 5.1. In the future, the plan is for Sun ONE products to migrate towards the use of the standard Java 1.4 logging APIs. Use of these proprietary log APIs is discouraged.  

 

java.util.List readLogRecord(java.lang.String logName, java.lang.String query)  

The log APIs for reading logs and setting or getting log attributes do not exist in iPlanet Directory Server Access Management Edition 5.1. In the future, the plan is for Sun ONE products to migrate towards the use of the standard Java 1.4 logging APIs. Use of these proprietary log APIs is discouraged.  

 

void setLogAttrs(java.lang.String logName, java.util.Hashtable logattrs)  

The log APIs for reading logs and setting or getting log attributes do not exist in iPlanet Directory Server Access Management Edition 5.1. In the future, the plan is for Sun ONE products to migrate towards the use of the standard Java 1.4 logging APIs. Use of these proprietary log APIs is discouraged.  

 

void write(LogRecord lr, java.lang.String logName)  

void write(LogRecord lr, java.lang.String logName)  

 

 

 

 

com.iplanet.portalserver.logging.LogRecord  

com.iplanet.log.LogRecord  

 

LogRecord(java.lang.String type, java.lang.String msg)  

LogRecord(java.lang.String type, java.lang.String msg)  

 

java.lang.String getRecMsg()  

java.lang.String getRecMsg()  

 

java.lang.String getRecType()  

java.lang.String getRecType()  

 

com.iplanet.portalserver.logging.LogException  

com.iplanet.log.LogException  

 

LogException()  

LogException()  

 

LogException(java.lang.String s)  

LogException(java.lang.String msg)  

 

LogException(java.lang.String s, int type)  

LogException(java.lang.String msg, int type)  

 

int getType()  

int getType()  

 

Table C-4 shows the API changes you need to know to migrate Sun ONE Portal Server 3.0 debug to iPlanet Directory Server Access Management Edition 5.1 debug APIs. This three-column table shows the method signature in Sun ONE Portal Server 3.0 in the first column. The second column shows the method signature in Sun ONE Portal Server 6.0. The third column shows the provider migration class method signature in Sun ONE Portal Server 6.0.


Table C-4    Migrating Sun ONE Portal Server 3.0 Debug to iPlanet Directory Server Access Management Edition 5.1 Debug APIs 

Method Signature in Sun ONE Portal Server 3.0

Method Signature in Sun ONE Portal Server 6.0

Provider Migration

Class Method Signature in Sun ONE Portal Server 6.0

com.iplanet.portalserver.util.Debug  

com.iplanet.am.util.Debug  

 

Debug(java.lang.String debugName)  

Use Debug.getInstance(String)  

 

boolean debugEnabled()  

Use Debug.messageEnabled()  

 

void destroy()  

void destroy()  

 

void error(java.lang.String msg)  

void error(java.lang.String msg)  

 

void error(java.lang.String msg, java.lang.Throwable t)  

void error(java.lang.String msg, java.lang.Throwable t)  

 

static Debug getInstance(java.lang.String debugName)  

static Debug getInstance(java.lang.String debugName)  

 

int getState()  

int getState()  

 

void message(java.lang.String msg)  

void message(java.lang.String msg)  

 

void message(java.lang.String msg, java.lang.Throwable t)  

void message(java.lang.String msg, java.lang.Throwable t)  

 

boolean messageEnabled()  

boolean messageEnabled()  

 

void setDebug()  

This is done by default by the Debug.getInstance call if setDebug(int) is not called. To return the Debug object to the debug level set in the system configuration file, use Debug.setDebug(SystemProperties.get("com.iplanet.services.debug.level"))  

 

void setDebug(int debugType)  

void setDebug(int debugType)  

 

void setDebug(java.lang.String debugType)  

void setDebug(java.lang.String debugType)  

 

void warning(java.lang.String msg)  

void warning(java.lang.String msg)  

 

void warning(java.lang.String msg, java.lang.Throwable t)  

void warning(java.lang.String msg, java.lang.Throwable t)  

 

boolean warningEnabled()  

boolean warningEnabled()  

 

Table C-5 shows the API changes you need to know to migrate the Desktop SDK from Sun ONE Portal Server 3.0 to Sun ONE Portal Server 6.0. This three-column table shows the Sun ONE Portal Server 3.0 class and method in the first column. The second column shows the Sun ONE Portal Server 6.0 class and method. The third column shows comments, if appropriate.


Table C-5    Migrating the Desktop SDK from Sun ONE Portal Server 3.0 to Sun ONE Portal Server 6.0 

Class/Method signature in Sun ONE Portal Server 3.0

Class/Method signature in Sun ONE Portal Server 6.0

Comments

Provider, ProviderAdapter, ProfileProviderAdapter  

 

 

init(Session)  

init(HttpServletRequest)  

remove dependency on specific service APIs, separation of service layer  

getBackgroundColor()  

 

type 2 property  

getColumn()  

 

type 2 property  

getEdit(Map)  

getEdit(HttpServletRequest, HttpServletResponse)  

Map argument version is deprecated. Use the HttpServletRequest version.  

getContent(Map)  

getContent(HttpServletRequest, HttpServletResponse)  

Map argument version is deprecated. Use HttpServletRequest version.  

getRow()