com.esri.arcgis.systemUI
Class ArcGISSingleSignon

java.lang.Object
  com.esri.arcgis.systemUI.ArcGISSingleSignon

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IArcGISPortal, IArcGISSingleSignon, java.io.Serializable

public class ArcGISSingleSignon
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcGISSingleSignon, IArcGISPortal

COM Class 'ArcGISSingleSignon'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriSystemUI.olb'

Description 'An object for working with the ArcGIS Single Sign on system.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.systemUI.IArcGISSingleSignon

IID, IIDe36dc321_5c5b_4d6b_884e_19ff4b5bbcac, xxDummy

Fields inherited from interface com.esri.arcgis.systemUI.IArcGISPortal

IID, IIDa128a18c_6769_4e4f_90a9_df413d139192, xxDummy

Constructor Summary

ArcGISSingleSignon()
Constructs a ArcGISSingleSignon using ArcGIS Engine.

ArcGISSingleSignon(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcGISSingleSignon theArcGISSingleSignon = (ArcGISSingleSignon) obj;

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
int	getBannerImage() method BannerImage
java.lang.String	getBannerImageUrl() method BannerImageUrl
static java.lang.String	getClsid() getClsid.
void	getCurrentToken(java.lang.String[] bsToken, java.lang.String[] bsReferer, int[] lExpiration, java.lang.String[] bsUser) Returns the current token and matching referer.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() method Name
java.lang.String	getPortal() method Portal
int	getSignonImage() method SignonImage
void	getToken(int hParentHWND, java.lang.String[] bsToken, java.lang.String[] bsReferer, int[] lExpiration, java.lang.String[] bsUser) Signs the user in to ArcGIS Online if required, and returns the current token and matching referer.
void	getURI(int eType, java.lang.String[] bsURI) Returns the requested ArcGIS online URI
int	hashCode() the hashcode for this object
boolean	isMultiTenant() method Name
void	release() Release a ArcGISSingleSignon.
void	signOut() Signs the user out of ArcGIS Online.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArcGISSingleSignon

public ArcGISSingleSignon()
                   throws java.io.IOException,
                          java.net.UnknownHostException

Constructs a ArcGISSingleSignon using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ArcGISSingleSignon

public ArcGISSingleSignon(java.lang.Object obj)
                   throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcGISSingleSignon theArcGISSingleSignon = (ArcGISSingleSignon) obj;

Construct a ArcGISSingleSignon using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ArcGISSingleSignon.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a ArcGISSingleSignon.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getToken

public void getToken(int hParentHWND,
                     java.lang.String[] bsToken,
                     java.lang.String[] bsReferer,
                     int[] lExpiration,
                     java.lang.String[] bsUser)
              throws java.io.IOException,
                     AutomationException

Signs the user in to ArcGIS Online if required, and returns the current token and matching referer.

Specified by:

getToken in interface IArcGISSingleSignon

Parameters:

hParentHWND - The hParentHWND (in)

bsToken - The bsToken (in/out: use single element array)

bsReferer - The bsReferer (in/out: use single element array)

lExpiration - The lExpiration (in/out: use single element array)

bsUser - The bsUser (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

signOut

public void signOut()
             throws java.io.IOException,
                    AutomationException

Signs the user out of ArcGIS Online.

Specified by:

signOut in interface IArcGISSingleSignon

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentToken

public void getCurrentToken(java.lang.String[] bsToken,
                            java.lang.String[] bsReferer,
                            int[] lExpiration,
                            java.lang.String[] bsUser)
                     throws java.io.IOException,
                            AutomationException

Returns the current token and matching referer.

Specified by:

getCurrentToken in interface IArcGISSingleSignon

Parameters:

bsToken - The bsToken (in/out: use single element array)

bsReferer - The bsReferer (in/out: use single element array)

lExpiration - The lExpiration (in/out: use single element array)

bsUser - The bsUser (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getURI

public void getURI(int eType,
                   java.lang.String[] bsURI)
            throws java.io.IOException,
                   AutomationException

Returns the requested ArcGIS online URI

Specified by:

getURI in interface IArcGISSingleSignon

Parameters:

eType - A com.esri.arcgis.systemUI.esriArcGISUri constant (in)

bsURI - The bsURI (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPortal

public java.lang.String getPortal()
                           throws java.io.IOException,
                                  AutomationException

method Portal

Specified by:

getPortal in interface IArcGISPortal

Returns:

The bsPortal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSignonImage

public int getSignonImage()
                   throws java.io.IOException,
                          AutomationException

method SignonImage

Specified by:

getSignonImage in interface IArcGISPortal

Returns:

The hBitmap

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBannerImage

public int getBannerImage()
                   throws java.io.IOException,
                          AutomationException

method BannerImage

Specified by:

getBannerImage in interface IArcGISPortal

Returns:

The hBitmap

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBannerImageUrl

public java.lang.String getBannerImageUrl()
                                   throws java.io.IOException,
                                          AutomationException

method BannerImageUrl

Specified by:

getBannerImageUrl in interface IArcGISPortal

Returns:

The bsUrl

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

method Name

Specified by:

getName in interface IArcGISPortal

Returns:

The bsName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMultiTenant

public boolean isMultiTenant()
                      throws java.io.IOException,
                             AutomationException

method Name

Specified by:

isMultiTenant in interface IArcGISPortal

Returns:

The isMulti

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.