Overview | Package | Class | Tree | Deprecated | Index | Help
| The PDK Java API is part of the Portal Developer Kit on Portal Studio
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## oracle.portal.provider.v2.http
Class ServletProviderUser

    java.lang.Object
      |
      +--oracle.webdb.utils.BaseUser
            |
            +--oracle.portal.provider.v2.ProviderUser
                  |
                  +--oracle.portal.provider.v2.http.ServletProviderUser

All Implemented Interfaces:
  java.security.Principal, oracle.security.jazn.realm.RealmPrincipal, oracle.security.jazn.realm.RealmUser

public class ServletProviderUser
extends ProviderUser

Fields inherited from class oracle.portal.provider.v2.ProviderUser
`AUTH_LEVEL_NOT_DETERMINED, AUTH_LEVEL_NOT_SUPPORTED, DEFAULT_SUBSCRIBER_NAME, NOT_AUTHENTICATED, PORTAL_PUBLIC, PUBLIC, PUBLIC_STRONG_AUTH, PUBLIC_USERNAME, PUBLIC_WEAK_AUTH, USER_STRONG_AUTH, USER_WEAK_AUTH`

Constructor Summary
`ServletProviderUser(javax.servlet.http.HttpServletRequest request)` Constructs this `ServletProviderUser` object.
`ServletProviderUser(javax.servlet.http.HttpServletRequest request, OidManager oidManager)` Constructs this `ServletProviderUser` object.
`ServletProviderUser(javax.servlet.http.HttpServletRequest request, java.lang.String name308, java.lang.String name309, java.lang.String subscriberId, java.lang.String companyName, int authLevel, java.lang.String mappedName, java.util.Calendar loginTime, java.lang.String portalSessionId, UserLocation location)` Constructs this `ServletProviderUser` object using the information supplied.
`ServletProviderUser(javax.servlet.http.HttpServletRequest request, java.lang.String name308, java.lang.String name309, java.lang.String subscriberId, java.lang.String companyName, int authLevel, java.lang.String mappedName, java.util.Calendar loginTime, java.lang.String portalSessionId, UserLocation location, OidManager oidManager, java.lang.String userDN, java.lang.String userGUID, java.lang.String subscriberDN, java.lang.String subscriberGUID)` Constructs this `ServletProviderUser` object using the information supplied.

Method Summary
`int` | `getAuthenticationLevel()` Gets the authentication level for the user.
`javax.servlet.http.Cookie[]` | `getCookies()` Gets an array of all the cookies established between this user and the provider, or a `null` value if the user currently has no cookies.
`java.lang.String` | `getDescription()` Get the users description
`java.lang.String` | `getDisplayName()` Get the users display name.
`java.lang.String` | `getEmail()` Get the portal user's email address.
`java.lang.String` | `getFirstName()` Get the portal user's first name.
`java.lang.String` | `getFullName()` Get the users full name.
`java.lang.String` | `getLastName()` Get the portal user's last name.
`UserLocation` | `getLocation()` Gets the user's location.
`java.util.Calendar` | `getLoginTime()` Gets the time when this user logged into the Portal.
`java.lang.String` | `getMappedName()` Gets the external application username that is mapped to this portal user.
`java.lang.String` | `getName()` Gets the name of the portal user represented by this object.
`PortalRealm` | `getPortalRealm()` Get the portal user' realm.
`java.lang.String` | `getPortalSessionId()` Gets the Portal session ID for this user.
`java.lang.String` | `getPropertyValue(java.lang.String propertyName)` Get a named property value of the user as stored in OID.
`ProviderSubscription` | `getProviderSubscription()` Gets subscription information related to this user/request Note, the subscription information is specific to the ProviderInstance the current request was received for.
`oracle.security.jazn.realm.Realm` | `getRealm()` Get the portal user's realm.
`ProviderSession` | `getSession()` Used to create and/or reacquire the user session.
`ProviderSession` | `getSession(boolean create)` Used to create and/or reacquire the user session.
`java.lang.String` | `getSubscriberDN()` Get the portal user's Subscription distinguished name.
`java.lang.String` | `getSubscriberGUID()` Get the portal user's subscriber GUID.
`java.lang.String` | `getSubscriberName()` Get the portal user's subscriber name.
`java.lang.String` | `getUserDN()` Get the portal user's distinguished name.
`java.lang.String` | `getUserGUID()` Get the portal user's GUID.
`boolean` | `isLDAPEnabled()` Determine if the OidManager is configured.
`boolean` | `isUserInGroup(java.lang.String groupName)` check if this user is a member of a group.

Methods inherited from class oracle.portal.provider.v2.ProviderUser
`getProviderSubscriptionKey, getQualifiedName, isLoggedOn, isPublicUser, isWeaklyAuthenticated`

Methods inherited from class oracle.webdb.utils.BaseUser
`equals, hashCode, setDescription, toString`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

### ServletProviderUser

    public ServletProviderUser(javax.servlet.http.HttpServletRequest request)

  Constructs this `ServletProviderUser` object. For performance, parameters will only be read from the given `HttpServletRequest` object when required.
  Parameters:
    `request` - a `HttpServletRequest`.

### ServletProviderUser

    public ServletProviderUser(javax.servlet.http.HttpServletRequest request,
                               OidManager oidManager)

  Constructs this `ServletProviderUser` object. For performance, parameters will only be read from the given `HttpServletRequest` object when required. Used in version 9.0.2.6
  Parameters:
    `request` - a `HttpServletRequest`.

### ServletProviderUser

    public ServletProviderUser(javax.servlet.http.HttpServletRequest request,
                               java.lang.String name308,
                               java.lang.String name309,
                               java.lang.String subscriberId,
                               java.lang.String companyName,
                               int authLevel,
                               java.lang.String mappedName,
                               java.util.Calendar loginTime,
                               java.lang.String portalSessionId,
                               UserLocation location)

  Constructs this `ServletProviderUser` object using the information supplied.

### ServletProviderUser

    public ServletProviderUser(javax.servlet.http.HttpServletRequest request,
                               java.lang.String name308,
                               java.lang.String name309,
                               java.lang.String subscriberId,
                               java.lang.String companyName,
                               int authLevel,
                               java.lang.String mappedName,
                               java.util.Calendar loginTime,
                               java.lang.String portalSessionId,
                               UserLocation location,
                               OidManager oidManager,
                               java.lang.String userDN,
                               java.lang.String userGUID,
                               java.lang.String subscriberDN,
                               java.lang.String subscriberGUID)

  Constructs this `ServletProviderUser` object using the information supplied. Used in version 9.0.2.6

Method Detail

### getName

    public java.lang.String getName()

  Gets the name of the portal user represented by this object.
  Overrides:
    `getName` in class `ProviderUser`
  Returns:
    the portal user name.

### getMappedName

    public java.lang.String getMappedName()

  Gets the external application username that is mapped to this portal user.
  Overrides:
    `getMappedName` in class `ProviderUser`
  Returns:
    the mapped application user. null if there is no mapped user.

### getProviderSubscription

    public ProviderSubscription getProviderSubscription()

  Gets subscription information related to this user/request Note, the subscription information is specific to the ProviderInstance the current request was received for.
  Overrides:
    `getProviderSubscription` in class `ProviderUser`
  Returns:
    ProviderSubscription object representing the subscription info or null if there is no subscription info.

### getRealm

    public oracle.security.jazn.realm.Realm getRealm()

  Get the portal user's realm. This method returns the generic Realm defined by `Realm`.
  Overrides:
    `getRealm` in class `ProviderUser`
  Returns:
    the portal realm.

### getPortalRealm

    public PortalRealm getPortalRealm()

  Get the portal user' realm. This method returns the Provider framework specific `PortalRealm` implementation.
  Overrides:
    `getPortalRealm` in class `ProviderUser`

### getLoginTime

    public java.util.Calendar getLoginTime()

  Gets the time when this user logged into the Portal.
  Overrides:
    `getLoginTime` in class `ProviderUser`
  Returns:
    the login time.

### getLocation

    public UserLocation getLocation()

  Gets the user's location. Value is allowed to be `null`, which means the information is not available.
  Overrides:
    `getLocation` in class `ProviderUser`
  Returns:
    a `UserLocation` object representing the user's location.

### getPortalSessionId

    public java.lang.String getPortalSessionId()

  Gets the Portal session ID for this user. Portlet developers can use this ID to map to their in memory "session" state vs. using a cookie based mechanism. The benefit is performance. If the provider doesn't use cookies the portal can communicate more efficiently with it.
  Overrides:
    `getPortalSessionId` in class `ProviderUser`
  Returns:
    the Portal session ID for this user.

### getAuthenticationLevel

    public int getAuthenticationLevel()

  Gets the authentication level for the user.
  Overrides:
    `getAuthenticationLevel` in class `ProviderUser`
  Returns:
    the authentication level.

### getSession

    public ProviderSession getSession(boolean create)

  Description copied from class: `ProviderUser`
  Used to create and/or reacquire the user session. If running as a Servlet and sessions are maintained via cookies then the sessions must only be created in Provider.initSession().

  Note: this method can throw an llegalStateException. This occurs if the user object has become stale. I.e. no longer contains the state that it needs to acquire/create the session.

  As all Provider/Portlet APIs give you access to the User object per request you should not (need to) retain the user object via reference in cross-request object (like the session itself). This only leads to possibilities of memory leaks.

  Overrides:
    `getSession` in class `ProviderUser`
  Following copied from class: `oracle.portal.provider.v2.ProviderUser`
  Parameters:
    `create` - if true then a session is created for the user if it doesn't currently exist.
  Returns:
    the session object for this user. null if create is false and the session doesn't already exist.

### getSession

    public ProviderSession getSession()

  Description copied from class: `ProviderUser`
  Used to create and/or reacquire the user session. Always creates a session if it doesn't currently exist. The same as calling getSession(true).

  If running as a Servlet and sessions are maintained via cookies then the sessions must only be created in Provider.initSession().

  Note: this method can throw an llegalStateException. This occurs if the user object has become stale. I.e. no longer contains the state that it needs to acquire/create the session.

  As all Provider/Portlet APIs give you access to the User object per request you should not (need to) retain the user object via reference in cross-request object (like the session itself). This only leads to possibilities of memory leaks.

  Overrides:
    `getSession` in class `ProviderUser`
  Following copied from class: `oracle.portal.provider.v2.ProviderUser`
  Returns:
    the session object for this user.

### getCookies

    public javax.servlet.http.Cookie[] getCookies()

  Gets an array of all the cookies established between this user and the provider, or a `null` value if the user currently has no cookies. Cookies must be established in the Provider's initSession method.
  Returns:
    an array of all this user's cookies or `null` if the user currently has no cookies.

### getUserDN

    public java.lang.String getUserDN()

  Get the portal user's distinguished name. This method returns the users distinguished name as stored in OID.
  Overrides:
    `getUserDN` in class `ProviderUser`
  Returns:
    the portal user's distinguished name.

### getSubscriberName

    public java.lang.String getSubscriberName()

  Get the portal user's subscriber name. This method returns the user's subscriber name as stored in OID
  Overrides:
    `getSubscriberName` in class `ProviderUser`
  Returns:
    the portal user's subscriber name.

### getSubscriberDN

    public java.lang.String getSubscriberDN()

  Get the portal user's Subscription distinguished name. This method returns the user's subscriber distinguished name as stored in OID.
  Overrides:
    `getSubscriberDN` in class `ProviderUser`
  Returns:
    the portal user's subscriber distinguished name.

### getUserGUID

    public java.lang.String getUserGUID()

  Get the portal user's GUID. This method returns the user's GUID as stored in OID.
  Overrides:
    `getUserGUID` in class `ProviderUser`
  Returns:
    the portal user's GUID.

### getSubscriberGUID

    public java.lang.String getSubscriberGUID()

  Get the portal user's subscriber GUID. This method returns the user's Subscriber GUID as stored in OID.
  Overrides:
    `getSubscriberGUID` in class `ProviderUser`
  Returns:
    the portal user's subscriber GUID.

### getFirstName

    public java.lang.String getFirstName()

  Get the portal user's first name. This method returns the user's first name as stored in OID.
  Overrides:
    `getFirstName` in class `ProviderUser`
  Returns:
    the portal user's first name.

### getLastName

    public java.lang.String getLastName()

  Get the portal user's last name. This method returns the user's last name as stored in OID.
  Overrides:
    `getLastName` in class `ProviderUser`
  Returns:
    the portal user's last name.

### getEmail

    public java.lang.String getEmail()

  Get the portal user's email address. This method returns the user's email address as stored in OID.
  Overrides:
    `getEmail` in class `ProviderUser`
  Returns:
    the portal user's email address.

### getPropertyValue

    public java.lang.String getPropertyValue(java.lang.String propertyName)

  Get a named property value of the user as stored in OID. Any property associated with the user can be queried that is stored in the OID user repository. Use the Oracle Directory Manager tool to find out all the properties available. Some of the commonly used property names are defined in OidManager class
  Overrides:
    `getPropertyValue` in class `ProviderUser`
  Parameters:
    `name` - of a user property
  Returns:
    the portal user's named property.

### isUserInGroup

    public boolean isUserInGroup(java.lang.String groupName)

  check if this user is a member of a group. The users, groups and group membership are stored in OID
  Overrides:
    `isUserInGroup` in class `ProviderUser`
  Parameters:
    `the` - name of the group
  Returns:
    the whether or not this user is a member of the named group

### isLDAPEnabled

    public boolean isLDAPEnabled()

  Determine if the OidManager is configured. This is needed because the methods return null if there is no Oid Manager or there is no data this method enables the caller to determine the reason why null was returned
  Overrides:
    `isLDAPEnabled` in class `ProviderUser`
  Returns:
    whether the oid manager is configured.

### getFullName

    public java.lang.String getFullName()

  Get the users full name. Get the users full name eg First name, Last name
  Overrides:
    `getFullName` in class `oracle.webdb.utils.BaseUser`
  Returns:
    the users full name

### getDisplayName

    public java.lang.String getDisplayName()

  Get the users display name.
  Overrides:
    `getDisplayName` in class `oracle.webdb.utils.BaseUser`
  Returns:
    the users display name

### getDescription

    public java.lang.String getDescription()

  Get the users description
  Overrides:
    `getDescription` in class `oracle.webdb.utils.BaseUser`
  Returns:
    the users description

Overview | Package | Class | Tree | Deprecated | Index | Help
| The PDK Java API is part of the Portal Developer Kit on Portal Studio
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright (c) 2002, Oracle Corporation. All Rights Reserved.