Bug 793458 (JBEPP-541)

Affects: Added: [Documentation (Ref Guide, User Guide, etc.)]

Is there info on how to change the IDM configuration anywhere?

Link: Added: This issue is a dependency of JBEPP-517

Could you describe a usecase?

Release Notes Docs Status: Added: Not Required

Boleslaw: No, sorry I can't provide a usecase.
I'll contact Martin Putz to see if he can provide something.

Link: Removed: This issue is a dependency of JBEPP-517 

Link: Added: This issue related JBEPP-545

Subject Matter Expert: Added: smumford
NEEDINFO: Added: Nobody

Subject Matter Expert: Removed: smumford 
NEEDINFO: Removed: Nobody 

Link: Added: This issue is a dependency of JBEPP-801

Secondary SME: Added: bdaw
NEEDINFO: Added: Reporter

From Boleslaw Dawidowicz:
This is not really well documented or supported. I think the easiest and fastest way at this point is to reimplement OrganizationService. So just replace the one that is defined in gatein.ear/02portal.war/WEB-INF/conf/organization/idm-configuration.xml.

There is also no documentation available but this is just a couple of interfaces to cover and it will replace usage of PicketLinkIDM with some custom solution.  

Hi Martin

We now describe how to set up IDM and JCR databases in the Installation Guide here:

http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platform/5.2/html/Installation_Guide/sect-Reference_Guide-Database_Configuration.html

Would the information in this section be sufficient for customers, or is more information required?

Cheers

Jared

Jared,

the chapter on how to configure the databases contains useful information. However, it does not cover the use case for which this bugzilla had been raised. What customers were asking for was how to create a custom implementation of OrganizationService, in order to store the IDM data in some custom tables.

We now have a KBase article which contains some pointers on how to get started with this task:
https://access.redhat.com/knowledge/solutions/74953

If it is too much effort to create similar content for the Reference / Developer Guide, then we can close this bugzilla, refine the KBase article, and point interested customers to this information.

-Martin

(In reply to comment #15)
> Jared,
> 
> the chapter on how to configure the databases contains useful information.
> However, it does not cover the use case for which this bugzilla had been
> raised. What customers were asking for was how to create a custom
> implementation of OrganizationService, in order to store the IDM data in some
> custom tables.
> 
> We now have a KBase article which contains some pointers on how to get started
> with this task:
> https://access.redhat.com/knowledge/solutions/74953
> 
> If it is too much effort to create similar content for the Reference /
> Developer Guide, then we can close this bugzilla, refine the KBase article, and
> point interested customers to this information.
> 
> -Martin

Thanks very much for the info Martin.

There's enough info in the KBase to convert to enterprise docs (nicely written procedural info).

Because the KBase is not yet viewable by Customers, and has not been verified (base on the statuses in the KBase), I think it should be converted instead of linked.

Cheers

J

TRIAGE INFORMATION

Relevance: EPP 5.2 and EPP 6

==Task==

Make the changes as prescribed in Comment16 in both versions. If you have problems accessing that KBase let me know and I can attach it to the ticket.

==Requirements== 

Ensure you have access to:

http://svn.jboss.org/repos/gatein/epp/docs/branches/5.2/ and http://svn.jboss.org/repos/gatein/epp/docs/branches/6.0/

to make changes to these guides.

==Resolving==

Add Revision History to each guide, and stage the books. 

Commit changes to SVN trunks.

Update the BZ with tracking info.

Martin,

I'm not sure I see the connection between the request for instructions on how to implement a custom DB schema and the Kbase article you linked which is about LastLoginTime.

Can you confirm that the URL [1] is correct, and if so, please explain how the two topics are related.

Thanks

1: https://access.redhat.com/knowledge/solutions/74953

Hi Scott,

the KBase article is indeed the best information we have on how to create custom classes to replace PicketLink IDM, although it has been written for a very specific use case.

I think the part between "In order to implement such a custom UserDAOImpl..." and "And finally, change..." is quite generic.

HTH,
Martin

Thanks Martin,

I've drafted some simple content based on the KBase article, trying to be generic while using the kbase usecase as an example.

Can you please review it and recommend any changes in a comment. I won't commit it to the document until it's verified by an SME.

Thanks

######### Draft Content ######################

Overview:

In order to implement a custom class, the following steps must be taken:

* Edit the 02portal.war/WEB-INF/conf/organization/idm-configuration.xml file to use the custom class.

* Create the custom implementation class. The easiest way to do this is to copy and edit one of the java files found at:
http://anonsvn.jboss.org/repos/gatein/epp/portal/tags/EPP_5_1_1_GA/component/identity/src/main/java/org/exoplatform/services/organization/idm/
DOCS NOTE: Is there any way for a user to get these from their local EPP instance? Or are these downloads the only way?

* Edit or remove any methods in the class that may interfere with the customized behavior you are implementing.
DOCS NOTE; A 'for further information about possible changes please refer to ...' would be good here.

Example:

The following is a step-by-step example of the changes outlined above.

This example disables writing a user's last login time to the database. 

1: Change the value for org.exoplatform.services.organization.OrganizationService in idm-configuration.xml:

<component>
    <key>org.exoplatform.services.organization.OrganizationService</key>
    <!--type>original.ExampleServiceImpl</type-->
    <type>custom.ExampleServiceImpl</type>
    <init-params>

Obtain a copy of http://anonsvn.jboss.org/repos/gatein/epp/portal/tags/EPP_5_1_1_GA/component/identity/src/main/java/org/exoplatform/services/organization/idm/PicketLinkIDMOrganizationServiceImpl.java
 

2: Change the constructor of the custom PicketLinkIDMOrganizationServiceImpl to use custom DAO implementations:

public PicketLinkIDMOrganizationServiceImpl(InitParams params, PicketLinkIDMService idmService) throws Exception {
    groupDAO_ = new GroupDAOImpl(this, idmService);
    userDAO_ = new UserDAOImpl(this, idmService);
    userProfileDAO_ = new UserProfileDAOImpl(this, idmService);
    membershipDAO_ = new MembershipDAOImpl(this, idmService);
    membershipTypeDAO_ = new MembershipTypeDAOImpl(this, idmService);


3: Remove the following code from the authenticate(..) method in the custom UserDAOImpl (as it sets the last login time):

if (authenticated)
{
    UserImpl userImpl = (UserImpl)user;
    userImpl.setLastLoginTime(Calendar.getInstance().getTime());
    saveUser(userImpl, false);
}