|
Compoze Software, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectportlets.compoze.groupware.c13n.DefaultAccountListener
portlets.compoze.groupware.c13n.DominoAccountListener
This class represents a Domino account listener for handling groupware accounts backed by Domino service.
Code is for example purpose.
Constructor Summary | |
DominoAccountListener()
|
Method Summary | |
ConnectionPropertyValue[] |
getAdditionalConnectionPropertyValues(javax.servlet.http.HttpSession httpSession,
GroupwareSession groupwareSession,
javax.servlet.http.HttpServletRequest request,
Account account,
com.bea.p13n.usermgmt.profile.ProfileWrapper userProfileWrapper)
Invoked when getting additional account property values. |
ConnectionPropertyValue[] |
getConnectionPropertyValues(javax.servlet.http.HttpSession session,
com.bea.p13n.usermgmt.profile.ProfileWrapper userProfileWrapper,
Account account,
ConnectionPropertyValue[] values)
Invoked when getting account property values. |
portlets.compoze.groupware.controls.provider.Provider |
getDefaultProvider()
Invoked when checking for the default provider. |
java.lang.String |
getRequiredAccountName(javax.servlet.http.HttpSession session,
com.bea.p13n.usermgmt.profile.ProfileWrapper userProfileWrapper)
Gets the name of the required account. |
boolean |
isAccountRequired(javax.servlet.http.HttpSession session,
com.bea.p13n.usermgmt.profile.ProfileWrapper userProfileWrapper)
Checks if at least one account is required. |
boolean |
isConfigurable()
Invoked when checking if users can configure accounts. |
boolean |
isPropertyModifiable(ConnectionProperty connProp)
Invoked when checking if the connection property is modifiable. |
boolean |
isPropertyRequired(ConnectionProperty connProp)
Invoked when checking if the connection property is required. |
boolean |
supportsMultipleAccounts()
Invoked when checking if multiple accounts are supported. |
Methods inherited from class portlets.compoze.groupware.c13n.DefaultAccountListener |
appendConnectionPropertyValue, appendConnectionPropertyValues, decodeValue, dumpConnectionPropertyValues, encodeValue, getAccountListener, getConnectionPropertyValue, getDefaultConnectionPropertyValues, isPasswordEncrypted, setConnectionPropertyValues |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DominoAccountListener()
Method Detail |
public boolean isPropertyModifiable(ConnectionProperty connProp)
isPropertyModifiable
in interface AccountListener
isPropertyModifiable
in class DefaultAccountListener
connProp
- the connection property
true
if the connection property is modifiable; false
otherwise
System administrator could allow/forbid user to modify certain connection property values when user adds or edits the groupware account. For example, if the Domino Service URL is designated for all the users, system administrator can make the Domino Service URL unmodifiable.
public boolean isPropertyRequired(ConnectionProperty connProp)
isPropertyRequired
in interface AccountListener
isPropertyRequired
in class DefaultAccountListener
connProp
- the connection property
true
if the connection property is required; false
otherwise
Connection required to establish a connection to the Domino service include:
Connection not required to establish a connection to the Domino service include:
public boolean supportsMultipleAccounts()
supportsMultipleAccounts
in interface AccountListener
supportsMultipleAccounts
in class DefaultAccountListener
true
if multiple accounts are supported; false
otherwise
A user may be allowed to have/access multiple Domino accounts. For example, user "Jack Smith" may be a member of the company's support team and therefore should have access to the Support account. Enabling multiple accounts support allow a user to have more than one groupware accounts and to access multiple Domino accounts in the same portal.
public boolean isConfigurable()
isConfigurable
in interface AccountListener
isConfigurable
in class DefaultAccountListener
true
if accounts are configurable; false
otherwise
User is allowed to configure the account(s).
public portlets.compoze.groupware.controls.provider.Provider getDefaultProvider()
getDefaultProvider
in interface AccountListener
getDefaultProvider
in class DefaultAccountListener
Domino service is the required groupware provider.
public ConnectionPropertyValue[] getConnectionPropertyValues(javax.servlet.http.HttpSession session, com.bea.p13n.usermgmt.profile.ProfileWrapper userProfileWrapper, Account account, ConnectionPropertyValue[] values) throws GroupwareException
getConnectionPropertyValues
in interface AccountListener
getConnectionPropertyValues
in class DefaultAccountListener
session
- the http session (may not be null
)userProfileWrapper
- the user profile (may not be null
)account
- the account (may not be null
)values
- an array of connection property values
Connection property values are obtained to initialize or create a session for a groupware account. The connection property values belongs to the account passed to this method.
The connection property values passed to this method could be re-processed here. The connection property value returned from this method could also be obtained from the portal through the user profile wrapper. They could also be extracted from a file, database, any network resources or any persistent store.
Here since we don't allow user to modify the Domino service URL (See #isPropertyModifiable), the Domino Service URL connection property value is appended as one of the connection properties returned.
GroupwareException
public boolean isAccountRequired(javax.servlet.http.HttpSession session, com.bea.p13n.usermgmt.profile.ProfileWrapper userProfileWrapper) throws GroupwareException
isAccountRequired
in interface AccountListener
isAccountRequired
in class DefaultAccountListener
session
- the http session (may not be null
)userProfileWrapper
- the user profile (may not be null
)
true
if an account is required; false
otherwise
At least one groupware account is required for a user to use the groupware portlet. Setting account not required won't set up a groupware account using the required account name (see #getRequiredAccountName) in case user doesn't have any groupware account setup.
GroupwareException
public java.lang.String getRequiredAccountName(javax.servlet.http.HttpSession session, com.bea.p13n.usermgmt.profile.ProfileWrapper userProfileWrapper) throws GroupwareException
getRequiredAccountName
in interface AccountListener
getRequiredAccountName
in class DefaultAccountListener
session
- the http session (may not be null
)userProfileWrapper
- the user profile (may not be null
)
null
)
GroupwareException
If user doesn't have any groupware account setup in the portal, and at least an account
is required (see #isAccountRequired), then this account will be set in the portal (with
missing connection properties).
public ConnectionPropertyValue[] getAdditionalConnectionPropertyValues(javax.servlet.http.HttpSession httpSession, GroupwareSession groupwareSession, javax.servlet.http.HttpServletRequest request, Account account, com.bea.p13n.usermgmt.profile.ProfileWrapper userProfileWrapper) throws GroupwareException
getAdditionalConnectionPropertyValues
in interface AccountListener
getAdditionalConnectionPropertyValues
in class DefaultAccountListener
httpSession
- the http session (may not be null
)groupwareSession
- the groupware session (may not be null
)account
- the grouwpware account for which to retrieve additional property values (may not be null
)userProfileWrapper
- the user profile (may not be null
)
GroupwareException
|
Compoze Software, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |