VMware Cloud Community
satoshi_goto
Contributor
Contributor
Jump to solution

Where is Javadoc of Orchestrator Java SDK & SsoAuthenticator class?

Hi,

I am using VMware vRealize Orchestrator 7.3.0.

I trying to use Orchestrator Java SDK, having two questions.

1. Is there Javadoc for Orchestrator Java SDK?

I saw "https://<our-vro-server>/vco-repo/javadoc", but there is no package "com.vmware.o11n.sdk.rest.client".

Is it closed?

2. Where is SsoAuthenticator class?

This page has a sample code to auth by Single Sign-on.

Using vCenter Single Sign-On Authentication with the Orchestrator REST API

I already saw Accessing Objects in Third-Party Systems :

SsoAuthenticator class can be found in o11n-rest-client-sso.jar, part of vCO Java REST SDK.

But, our vRO's archetype repository doesn't have SsoAuthenticator.

Other classes like "VcoSessionFactory" is found in "o11n-rest-client-services" at "com.vmware.o11n" group.

Please let me know the answer. Thanks.

Tags (1)
0 Kudos
1 Solution

Accepted Solutions
iiliev
VMware Employee
VMware Employee
Jump to solution

It is the URL of SSO administration server, which is one of the components of vCenter SSO. For further details, check VMware documentation, eg. https://docs.vmware.com/en/VMware-vSphere/6.0/com.vmware.vsphere.install.doc/GUID-90C1E3DC-4397-4BF0...

Usually, it looks something like https://{FQDN}:{port}/sso-adminserver/sdk/vsphere.local

View solution in original post

0 Kudos
4 Replies
iiliev
VMware Employee
VMware Employee
Jump to solution

Hi,

1. That's the proper URL to the Javadoc. The problem is that not all libraries part of the SDK have their Javadoc generated/bundled in the appliance. Not sure why.

2. The problem here is that the libraries in vRO repository are split into two bundles - one public and one related to interactions with other VMware products, eg. SSO. In old vRO releases, there were some issues around how to legally package and distribute the second bundle, and that's why you don't see the libraries from this bundle in the hosted Maven repository. Not sure what is the situation with the latest vRO releases (6.x and 7.x); perhaps these legal issues are not applicable anymore.

For the time being, if you can't find some library in the hosted Maven repository (like o11n-rest-client-sso), you can retrieve its jar file from the libraries used by vRO server and Control Center; search under /usr/lib/vco/app-server/ and /usr/lib/vco/configuration/

0 Kudos
satoshi_goto
Contributor
Contributor
Jump to solution

Thanks for your reply.

1. That's the proper URL to the Javadoc. The problem is that not all libraries part of the SDK have their Javadoc generated/bundled in the appliance. Not sure why.

Ok, I understand.

2. The problem here is that the libraries in vRO repository are split into two bundles - one public and one related to interactions with other VMware products, eg. SSO. In old vRO releases, there were some issues around how to legally package and distribute the second bundle, and that's why you don't see the libraries from this bundle in the hosted Maven repository. Not sure what is the situation with the latest vRO releases (6.x and 7.x); perhaps these legal issues are not applicable anymore.

For the time being, if you can't find some library in the hosted Maven repository (like o11n-rest-client-sso), you can retrieve its jar file from the libraries used by vRO server and Control Center; search under /usr/lib/vco/app-server/ and /usr/lib/vco/configuration/

I found "/usr/lib/vco/configuration/lib/ext/o11n-rest-client-sso.jar" at vRO server.

It contains SsoAuthenticator class. Thanks a lot. :smileylaugh::smileylaugh::smileylaugh:

I have an another question.

Documents of vRO SSO says that SsoAuthenticator class has a constructor which has four arguments.

//create a factory for vCenter Single Sign-On tokens

SsoAuthenticator sso = new SsoAuthenticator(URI ssoUri, URI adminUri, VcoSessionFactory vcoSessionFactory, long lifeTimeSeconds);

Using vCenter Single Sign-On Authentication with the Orchestrator REST API

But "adminUri" is not described at sample code.

What I use for adminUri?

0 Kudos
iiliev
VMware Employee
VMware Employee
Jump to solution

It is the URL of SSO administration server, which is one of the components of vCenter SSO. For further details, check VMware documentation, eg. https://docs.vmware.com/en/VMware-vSphere/6.0/com.vmware.vsphere.install.doc/GUID-90C1E3DC-4397-4BF0...

Usually, it looks something like https://{FQDN}:{port}/sso-adminserver/sdk/vsphere.local

0 Kudos
satoshi_goto
Contributor
Contributor
Jump to solution

Usually, it looks something like https://{FQDN}:{port}/sso-adminserver/sdk/vsphere.local

Thanks for your quick advice!

I barely success to authenticate SSO by "https://{FQDN}:{port}/sso-adminserver/sdk/vsphere.local".

0 Kudos