Logging a custom connector and plugins within OIM 11g

Here are the steps on how to enable your logging for your custom connector.
October 8, 2015
OIM-11gLogging

In order to custom develop OIM's scheduled tasks or event handlers, you must first enable the custom logging. In OIM 11g and above, you can now instantiate the logging within enterprise manager (em) and leverage off the logging setting available from the GUI. In order to do this, you must first instantiate the logging instance within your schedule task and deploy this successfully. This blog assumes you've already deployed the schedule task or event handler though there's a quick blog post on preparing the OIM 11g Custom Plugin files within JDeveloper if you haven't done this already.


1. Import com.thortech.util.logging.Logger

You will need to 'import com.thortech.util.logging.Logger' class within your custom code. If the package cannot be located then you need to ensure the oimclient.jar is also associated to your design. For this example, don't use the other java.util.logging.Logger import within your code

import com.thortech.util.logging.Logger


2. Import com.thortech.util.logging.Logger

Once that's imported in successfully, ensure you have a 'private static final logger' instance within your custom connector or plugin. Because this is static

For example

private static final logger LOGGER = Logger.getLogger(ExampleClass.class.getName())


3. Use the LOGGER instance

Now you have the freedom to us the LOGGER instance anywhere within your code. The log levels available can be located within the post, Logging in Oracle Identity Manager By Using log4j.

For example

LOGGER.info("***** THIS IS THE LOG *****");


4. Setup the Enterprise Manager Logger

Once you've compiled your code and imported this into OIM, run the code at least once for OIM (and the logger configuration) to acknowledge your custom code. If it's a custom scheduled task for example, just run the schedule task within the OIM GUI Once you've executed the plugin, go to Oracle's Enterprise Manager (URL will be hostname:7001/em). Got to Weblogic Domains -- idmdomain -- oim_sever1 then right click on the server and select Logs, Log Configuration Once you've done that, expand out to see your class by navigating through the packages (This is obviously the package you provided to the custom code). If you cannot see the custom code class, it's possible that because you're not looking hard enough, or that the custom code was not executed, or the code was executed though never reached any of your LOGGER methods within your code. Once you have located the class, click down on the Oracle diagnostic Logger Level (Java Level) and select the logger lever. IMPORTANT - you must make a change to this. If the logger lever is already set, you need to save to another log level, then make another change.. Before you save, click on the 'Persist log level state across component restarts'. This must be ticked for your logger handler to acknowledge this. Once you've saved this, you should see the persistant log level state populated. Once you've done that, click on the 'log files' tab


5. Setup the handler

The handler will acknowledge any changes to your custom code and populate that information into a dedicated log file. I would probably recommend clicking on the 'create like' so most of it's already configured for you. Obviously you'll need to alter the logger name, the file name, etc... it's fairly self-explanatory. Once you've done that, save the logging handler and execute the OIM schedule task or event handler to then determine the population of the logging.

About the author

Daniel is a Technical Manager with over 10 years of consulting expertise in the Identity and Access Management space.
Daniel has built from scratch this blog as well as technicalconfessions.com
Follow Daniel on twitter @nervouswiggles

Comments

Other Posts

HOW TO provision AD group membership from OpenIDM

OpenIDMICFAD-connector

June 15, 2018
Created by: Daniel Redfern
For what I see, there's not too many supportive documentations out there that will demonstrate how provision AD group membership with the ICF connector using OpenIDM. The use of the special ldapGroups attribute is not explained anywhere in the Integrators guides to to the date of this blog. This quick blog identifies the tasks required to provision AD group membership from OpenIDM to AD using the LDAP ICF connector. However this doesn't really explain what ldapGroups actually does and there's no real worked example of how to go from an Assignment to ldapGroups to an assigned group in AD. I wrote up a wiki article for my own reference: AD group memberships automatically to users This is just my view, others may disagree, but I think the implementation experience could be improved with some more documentation and a more detailed example here.
Read More...

ForgeRock OpenIDM - InvalidCredentialException: Remote framework key is invalid

ICFIDMOpenIDMOpenICF

November 8, 2017
Created by: Daniel Redfern
In the past, the similar error occurred though for the Oracle Identity Management solution. invalidcredentialexception remote framework key is invalid Because they all share the ICF connector framework, the error/solution would be the same.
Read More...

org.forgerock.script.exception.ScriptCompilationException: missing ; before statement

IDMsync.confforgerockopenidm

November 8, 2017
Created by: Daniel Redfern
org.forgerock.script.exception.ScriptCompilationException: missing ; before statement
Read More...

ForgeRock IDM - org.forgerock.script.exception.ScriptCompilationException: missing ; before statemen

OpenIDMsync.confForgeRock

September 17, 2017
Created by: Daniel Redfern
ForgeRock IDM - org.forgerock.script.exception.ScriptCompilationException: missing ; before statement
Read More...

Caused by: org.forgerock.json.resource.BadRequestException: Target does not support attribute groups

OpenIDMForgeRockICFConnector

September 17, 2017
Created by: Daniel Redfern
When performing the attempt of a reconciliation from ForgeRock IDM to Active Directory, I would get the following error
Read More...

ForgeRock OpenIDM - InvalidCredentialException: Remote framework key is invalid

OpenIDMForgeRockICFConnectorAD

September 17, 2017
Created by: Daniel Redfern
In the past, the similar error occurred though for the Oracle Identity Management solution. invalidcredentialexception remote framework key is invalid Because they all share the ICF connector framework, the error/solution would be the same.
Read More...

ERROR Caused by com.google.api.client.auth.oauth2.TokenResponseException 400 Bad Request - invalid_g

OpenIDMIDMGoogleGoogle-AppsICFreconciliation

September 12, 2017
Created by: Daniel Redfern
During the reconcilation from OpenIDM to the ICF google apps connector, the following error response would occur. ERROR Caused by com.google.api.client.auth.oauth2.TokenResponseException 400 Bad Request - invalid_grant
Read More...

forgerock-openidm-encryptedjwt-error

OpenIDMIDMForgeRockJWTIAM

August 29, 2017
Created by: Daniel Redfern
Received the JWT error
Read More...

Unexpected character ('¾' (code 190)): expected a valid value

ForgeRock-OpenIDMOpenIDMIDMKeystore

June 25, 2017
Created by: Daniel Redfern
Unexpected character occurred when the IP addresses changes and the virtual instance was migrated into a separate network subnet.
Read More...

OpenDJ Error - Connect Error Result Code: 91 (Connect Error)

OpenDJLDAPldapsearchForgeRock

June 5, 2017
Created by: Daniel Redfern
When trying to connect, I would then receive the following error "Connect Error Result Code: 91 (Connect Error)"
Read More...