|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.netuix.servlets.manager.communities.CommunityRedirectionHelper
public class CommunityRedirectionHelper
The CommunityRedirectionHelper
contains methods useful for
redirecting to community error or registration pages, as well as methods for
determining contextual information on a community error or registration page.
Field Summary | |
---|---|
static int |
REDIRECTION_TYPE_COMMUNITY_DEACTIVATED
The code indicating a redirection due to the community being deactivated. |
static int |
REDIRECTION_TYPE_MEMBER_DEACTIVATED
The code indicating a redirection due to the member being deactivated. |
static int |
REDIRECTION_TYPE_MEMBERSHIP_DEACTIVATED
The code indicating a redirection due to the membership being deactivated. |
static int |
REDIRECTION_TYPE_NO_PUBLIC_ACCESS
The code indicating a redirection due to the community not having public access. |
static int |
REDIRECTION_TYPE_REGISTRATION
The code indicating a redirection to a registration page. |
static int |
REDIRECTION_TYPE_UNKNOWN
The code indicating a redirection due to unknown reasons. |
Method Summary | |
---|---|
GenericURL |
addCommunityRedirectionParameters(GenericURL url)
Adds parameters to a GenericURL object (the superclass of PostbackURL ,
WindowURL and others) to re-encode community redirection state so that the
CommunityRedirectionHelper can be used on subsequent page renders. |
static GenericURL |
generateRegistrationPageUrl(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
CommunityDefinition community)
Generates a URL to the registration page for the specified community. |
static CommunityRedirectionHelper |
getCommunityRedirectionHelper(javax.servlet.http.HttpServletRequest request)
A convenience method for returning the CommunityRedirectionHelper object associated
with the specified Request. |
CommunityContext |
getRedirectingCommunityContext()
Retrieves the CommunityContext for the community which caused a redirection to
the current page, if applicable. |
String |
getRedirectingErrorMessage()
Returns a message appropriate for the redirection type that caused the redirection leading to this page render. |
Invitation |
getRedirectingInvitation()
Returns the invitation (encoded through the validation key in the registration page URL) behind this redirection, if one exists. |
int |
getRedirectingTypeCode()
Retrieves the type code (one of the REDIRECTION_TYPE constants) for the underlying reason that caused the redirection to this page render. |
String |
getRedirectingURL()
Returns the requested URL which caused the redirection to the current page, if such a URL exists. |
static String |
getTypeMessage(int typeCode)
Retrieves the message appropriate for the specified redirection type. |
boolean |
isRedirectionCommunityDeactivated()
Returns true if the current page render is the result of a community redirection for community deactivation. |
boolean |
isRedirectionMemberDeactivated()
Returns true if the current page render is the result of a community redirection for member deactivation. |
boolean |
isRedirectionMembershipDeactivated()
Returns true if the current page render is the result of a community redirection for membership deactivation. |
boolean |
isRedirectionNoPublicAccess()
Returns true if the current page render is the result of a community redirection because the community has no public access. |
boolean |
isRedirectionRegistration()
Returns true if the current page render is the result of a community redirection for registration. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int REDIRECTION_TYPE_REGISTRATION
public static final int REDIRECTION_TYPE_COMMUNITY_DEACTIVATED
public static final int REDIRECTION_TYPE_MEMBER_DEACTIVATED
public static final int REDIRECTION_TYPE_MEMBERSHIP_DEACTIVATED
public static final int REDIRECTION_TYPE_NO_PUBLIC_ACCESS
public static final int REDIRECTION_TYPE_UNKNOWN
Method Detail |
---|
public static CommunityRedirectionHelper getCommunityRedirectionHelper(javax.servlet.http.HttpServletRequest request)
CommunityRedirectionHelper
object associated
with the specified Request. If the page currently being rendered is not the result of a community
redirect (caused by community / member / membership deactivation, no public access to a community,
or a need to register) this method will return null
.
request
- the HttpServletRequest
.
CommunityRedirectionHelper
object associated with the request, if the current
page render is the result of a redirection from a community, or null
if no redirection took place.public CommunityContext getRedirectingCommunityContext()
CommunityContext
for the community which caused a redirection to
the current page, if applicable. When the user is redirected to a community error
or registration page, this method can be used from the error or registration
page to determine which community the user attempted to access.
CommunityContext
for the community which triggered the redirection
to the current page, if applicable. This is only applicable when the user has been
redirected to a community error or registration page. When not applicable,
null
is returned.public Invitation getRedirectingInvitation()
null
otherwise.public String getRedirectingURL()
null
if there is no redirecting page.public int getRedirectingTypeCode()
public boolean isRedirectionRegistration()
public boolean isRedirectionCommunityDeactivated()
public boolean isRedirectionMemberDeactivated()
public boolean isRedirectionMembershipDeactivated()
public boolean isRedirectionNoPublicAccess()
public String getRedirectingErrorMessage()
public GenericURL addCommunityRedirectionParameters(GenericURL url)
GenericURL
object (the superclass of PostbackURL
,
WindowURL
and others) to re-encode community redirection state so that the
CommunityRedirectionHelper
can be used on subsequent page renders.
url
- the URL object to add parameters to.
GenericURL
,
JspContentURL
,
PageURL
,
PostbackURL
,
ResourceURL
,
StandalonePortletURL
,
WindowURL
public static String getTypeMessage(int typeCode)
typeCode
- one of thr REDIRECTION_TYPE constants.
public static GenericURL generateRegistrationPageUrl(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, CommunityDefinition community)
CommunityDefinition
object into a full, valid URL.
It does not check to see whether the community has public registration enabled.
It may generate a URL which is inappropriate to display for security or access reasons.
For this reason, it is always safest to have the registration page check to make sure
registration is appropriate for the community before it creates a membership.
request
- the HttpServletRequest
.response
- the HttpServletResponse
.community
- the CommunityDefinition
for the community.
CommunityRedirectionHelper
class from the registration page.
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |