|
Oracle Fusion Middleware Java API Reference for Oracle PDK Java 11g Release 1 (11.1.1) E10691-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.webdb.provider.v2.utils.BaseProviderUser oracle.portal.provider.v2.ProviderUser oracle.portal.provider.v2.http.ServletProviderUser
public class ServletProviderUser
Field Summary |
---|
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. |
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 |
isDeactivated()
Returns if the user is deactivated This method is not actually implemented. |
boolean |
isLDAPEnabled()
Determine if the OidManager is configured. |
boolean |
isUserInGroup(java.lang.String groupName)
check if this user is a member of a group. |
void |
setDeactivated(boolean deactivate)
Sets the user to be deactivated This method is not actually implemented. |
Methods inherited from class oracle.portal.provider.v2.ProviderUser |
---|
getProviderSubscriptionKey, getQualifiedName, isLoggedOn, isPublicUser, isWeaklyAuthenticated |
Methods inherited from class oracle.webdb.provider.v2.utils.BaseProviderUser |
---|
equals, hashCode, toString |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ServletProviderUser(javax.servlet.http.HttpServletRequest request)
ServletProviderUser
object. For
performance, parameters will only be read from the given
HttpServletRequest
object when required.
request
- a HttpServletRequest
.public ServletProviderUser(javax.servlet.http.HttpServletRequest request, OidManager oidManager)
ServletProviderUser
object. For
performance, parameters will only be read from the given
HttpServletRequest
object when required.
Used in version 9.0.2.6
request
- a HttpServletRequest
.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)
ServletProviderUser
object using the
information supplied.
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)
ServletProviderUser
object using the
information supplied.
Used in version 9.0.2.6
Method Detail |
---|
public java.lang.String getName()
getName
in interface java.security.Principal
getName
in class ProviderUser
public java.lang.String getMappedName()
getMappedName
in class ProviderUser
public ProviderSubscription getProviderSubscription()
getProviderSubscription
in class ProviderUser
public PortalRealm getPortalRealm()
PortalRealm
implementation.
getPortalRealm
in class ProviderUser
public java.util.Calendar getLoginTime()
getLoginTime
in class ProviderUser
public UserLocation getLocation()
null
,
which means the information is not available.
getLocation
in class ProviderUser
UserLocation
object representing the user's location.public java.lang.String getPortalSessionId()
getPortalSessionId
in class ProviderUser
public int getAuthenticationLevel()
getAuthenticationLevel
in class ProviderUser
public ProviderSession getSession(boolean create)
ProviderUser
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.
getSession
in class ProviderUser
create
- if true then a session is created for the user if it
doesn't currently exist.
public ProviderSession getSession()
ProviderUser
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.
getSession
in class ProviderUser
public javax.servlet.http.Cookie[] getCookies()
null
value if the user currently has no
cookies. Cookies must be established in the Provider's initSession
method.
null
if the
user currently has no cookies.public java.lang.String getUserDN()
getUserDN
in class ProviderUser
public java.lang.String getSubscriberName()
getSubscriberName
in class ProviderUser
public java.lang.String getSubscriberDN()
getSubscriberDN
in class ProviderUser
public java.lang.String getUserGUID()
getUserGUID
in class ProviderUser
public java.lang.String getSubscriberGUID()
getSubscriberGUID
in class ProviderUser
public java.lang.String getFirstName()
getFirstName
in class ProviderUser
public java.lang.String getLastName()
getLastName
in class ProviderUser
public java.lang.String getEmail()
getEmail
in class ProviderUser
public java.lang.String getPropertyValue(java.lang.String propertyName)
getPropertyValue
in class ProviderUser
propertyName
- of a user property
public boolean isUserInGroup(java.lang.String groupName)
isUserInGroup
in class ProviderUser
groupName
- the name of the group
public boolean isLDAPEnabled()
isLDAPEnabled
in class ProviderUser
public java.lang.String getFullName()
public java.lang.String getDisplayName()
public java.lang.String getDescription()
public boolean isDeactivated()
public void setDeactivated(boolean deactivate)
|
Oracle Fusion Middleware Java API Reference for Oracle PDK Java 11g Release 1 (11.1.1) E10691-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |