RolePortlet - JBOSS Portal 2.6 API 英文版文档

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.portal.core.portlet.role
Class RolePortlet

java.lang.Object
  org.jboss.portlet.JBossPortlet
      org.jboss.portal.core.portlet.role.RolePortlet

All Implemented Interfaces:: Portlet

public class RolePortlet
extends JBossPortlet

This portlet aims at managing roles of users.

Version:: $Revision: 5448 $
Author:: Noel Rocher, Julien Viet, Thomas Heute , Roy Russo : roy at jboss dot org

Field Summary

private static java.lang.String ADMIN_ROLE


static org.jboss.logging.Logger log
          the class logger

static java.lang.String OP_SHOWADDROLESTOUSER
          Render operation to show the screen to assign roles to a user

static java.lang.String OP_SHOWCREATEROLE


static java.lang.String OP_SHOWEDITROLE


static java.lang.String OP_SHOWLISTROLEMEMBERS
          Edit role page where admins can edit the members individually.

static java.lang.String OP_SHOWMAINROLEMEMBERS
          Main Edit role page where admins can filter

static java.lang.String OP_SHOWSUMMARY


private PortletHelper portletHelper


private RoleModule roleModule


private UserModule userModule


Fields inherited from class org.jboss.portlet.JBossPortlet

Constructor Summary

RolePortlet()


Method Summary

void addRolesToUser(JBossActionRequest request, JBossActionResponse response)
          Adds or Removes roles from a user.

void createRole(JBossActionRequest req, JBossActionResponse resp)


void destroy()
          Called by the portlet container to indicate to a portlet that the portlet is being taken out of service.

protected void doView(JBossRenderRequest req, JBossRenderResponse resp)
          Throw a PortletException.

void editRole(JBossActionRequest req, JBossActionResponse resp)
          Action to edit a role

private void forbidden(RenderRequest rReq, RenderResponse rRes)
          Handles permissions errors on doView.

java.lang.String getDefaultOperation()
          Return the string main, it can be overriden to return another value by subclasses.

private java.lang.String getFullName(java.util.ResourceBundle bundle, User user)
          This is a helper method extracted from the userPortlet that returns the user's fullname.

private java.lang.String getNbRolesString(java.util.ResourceBundle bundle)
          Return a localized sentence stating the number of existing roles

void init()


void removeRole(JBossActionRequest req, JBossActionResponse resp)
          Action to delete a role

private boolean roleByDisplayNameAvailable(java.lang.String name)
          Returns true if the role with display name in argument is available

private boolean roleByNameAvailable(java.lang.String name)
          Returns true if the role with name in argument is available

void showListEditRoleMembers(JBossActionRequest req, JBossActionResponse resp)


Methods inherited from class org.jboss.portlet.JBossPortlet

doDispatch, doEdit, doHelp, getInitParameter, getInitParameterNames, getOperationName, getPortletConfig, getPortletContext, getPortletName, getResourceBundle, getTitle, init, processAction, processAction, processDispatch, processEdit, processHelp, processView, render, render

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

public static final org.jboss.logging.Logger log

the class logger

portletHelper

private PortletHelper portletHelper

OP_SHOWSUMMARY

public static final java.lang.String OP_SHOWSUMMARY

See Also:: Constant Field Values

OP_SHOWCREATEROLE

public static final java.lang.String OP_SHOWCREATEROLE

See Also:: Constant Field Values

OP_SHOWEDITROLE

public static final java.lang.String OP_SHOWEDITROLE

See Also:: Constant Field Values

OP_SHOWMAINROLEMEMBERS

public static final java.lang.String OP_SHOWMAINROLEMEMBERS

Main Edit role page where admins can filter

See Also:: Constant Field Values

OP_SHOWLISTROLEMEMBERS

public static final java.lang.String OP_SHOWLISTROLEMEMBERS

Edit role page where admins can edit the members individually.

See Also:: Constant Field Values

OP_SHOWADDROLESTOUSER

public static final java.lang.String OP_SHOWADDROLESTOUSER

Render operation to show the screen to assign roles to a user

See Also:: Constant Field Values

roleModule

private RoleModule roleModule

userModule

private UserModule userModule

ADMIN_ROLE

private static final java.lang.String ADMIN_ROLE

See Also:: Constant Field Values

Constructor Detail

RolePortlet

public RolePortlet()

Method Detail

init

public void init()
          throws PortletException

Overrides:: init in class JBossPortlet

Throws:: PortletException

destroy

public void destroy()

Description copied from interface: Portlet

Called by the portlet container to indicate to a portlet that the portlet is being taken out of service.

Before the portlet container calls the destroy method, it should allow any threads that are currently processing requests within the portlet object to complete execution. To avoid waiting forever, the portlet container can optionally wait for a predefined time before destroying the portlet object.

This method enables the portlet to do the following:

clean up any resources that it holds (for example, memory, file handles, threads)
make sure that any persistent state is synchronized with the portlet current state in memory.

Specified by:: destroy in interface Portlet
Overrides:: destroy in class JBossPortlet

getDefaultOperation

public java.lang.String getDefaultOperation()

Description copied from class: JBossPortlet

Return the string main, it can be overriden to return another value by subclasses.

Overrides:: getDefaultOperation in class JBossPortlet

doView

protected void doView(JBossRenderRequest req,
                      JBossRenderResponse resp)
               throws PortletException,
                      PortletSecurityException,
                      java.io.IOException

Description copied from class: JBossPortlet

Throw a PortletException.

Overrides:: doView in class JBossPortlet

Throws:: PortletException; PortletSecurityException; java.io.IOException

showListEditRoleMembers

public void showListEditRoleMembers(JBossActionRequest req,
                                    JBossActionResponse resp)
                             throws WindowStateException

Throws:: WindowStateException

forbidden

private void forbidden(RenderRequest rReq,
                       RenderResponse rRes)
                throws PortletException,
                       java.io.IOException

Handles permissions errors on doView.

Parameters:: rReq -; rRes -
Throws:: PortletException; java.io.IOException

createRole

public void createRole(JBossActionRequest req,
                       JBossActionResponse resp)

editRole

public void editRole(JBossActionRequest req,
                     JBossActionResponse resp)
              throws WindowStateException

Action to edit a role

Parameters:: req -; resp -
Throws:: WindowStateException

addRolesToUser

public void addRolesToUser(JBossActionRequest request,
                           JBossActionResponse response)

Adds or Removes roles from a user.

Parameters:: request -; response -

removeRole

public void removeRole(JBossActionRequest req,
                       JBossActionResponse resp)

Action to delete a role

Parameters:: req -; resp -

roleByDisplayNameAvailable

private boolean roleByDisplayNameAvailable(java.lang.String name)

Returns true if the role with display name in argument is available

Parameters:: name - Display name of the role to check
Returns:: true if the display name is available

roleByNameAvailable

private boolean roleByNameAvailable(java.lang.String name)

Returns true if the role with name in argument is available

getNbRolesString

private java.lang.String getNbRolesString(java.util.ResourceBundle bundle)

Return a localized sentence stating the number of existing roles

getFullName

private java.lang.String getFullName(java.util.ResourceBundle bundle,
                                     User user)

This is a helper method extracted from the userPortlet that returns the user's fullname.

Parameters:: bundle -; user -