com.esri.arcgis.systemUI
Class ArcGISSingleSignon

java.lang.Object
  extended by com.esri.arcgis.systemUI.ArcGISSingleSignon
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IArcGISPortal, IArcGISSingleSignon, Serializable

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

An object for working with the ArcGIS Single Sign on system.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:
Serialized Form

Constructor Summary
ArcGISSingleSignon()
          Constructs a ArcGISSingleSignon using ArcGIS Engine.
ArcGISSingleSignon(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcGISSingleSignon theArcGISSingleSignon = (ArcGISSingleSignon) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 int getBannerImage()
          method BannerImage
 String getBannerImageUrl()
          method BannerImageUrl
static String getClsid()
          getClsid.
 void getCurrentToken(String[] bsToken, String[] bsReferer, int[] lExpiration, String[] bsUser)
          Returns the current token and matching referer.
 String getName()
          method Name
 String getPortal()
          method Portal
 int getSignonImage()
          method SignonImage
 void getToken(int hParentHWND, String[] bsToken, String[] bsReferer, int[] lExpiration, String[] bsUser)
          Signs the user in to ArcGIS Online if required, and returns the current token and matching referer.
 void getURI(int eType, String[] bsURI)
          Returns the requested ArcGIS online URI
 int hashCode()
          the hashcode for this object
 boolean isMultiTenant()
          method Name
 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
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

ArcGISSingleSignon

public ArcGISSingleSignon()
                   throws IOException,
                          UnknownHostException
Constructs a ArcGISSingleSignon using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

ArcGISSingleSignon

public ArcGISSingleSignon(Object obj)
                   throws 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:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getToken

public void getToken(int hParentHWND,
                     String[] bsToken,
                     String[] bsReferer,
                     int[] lExpiration,
                     String[] bsUser)
              throws IOException,
                     AutomationException
Signs the user in to ArcGIS Online if required, and returns the current token and matching referer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

signOut

public void signOut()
             throws IOException,
                    AutomationException
Signs the user out of ArcGIS Online.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
signOut in interface IArcGISSingleSignon
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentToken

public void getCurrentToken(String[] bsToken,
                            String[] bsReferer,
                            int[] lExpiration,
                            String[] bsUser)
                     throws IOException,
                            AutomationException
Returns the current token and matching referer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getURI

public void getURI(int eType,
                   String[] bsURI)
            throws IOException,
                   AutomationException
Returns the requested ArcGIS online URI

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPortal

public String getPortal()
                 throws IOException,
                        AutomationException
method Portal

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getPortal in interface IArcGISPortal
Returns:
The bsPortal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSignonImage

public int getSignonImage()
                   throws IOException,
                          AutomationException
method SignonImage

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getSignonImage in interface IArcGISPortal
Returns:
The hBitmap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBannerImage

public int getBannerImage()
                   throws IOException,
                          AutomationException
method BannerImage

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getBannerImage in interface IArcGISPortal
Returns:
The hBitmap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBannerImageUrl

public String getBannerImageUrl()
                         throws IOException,
                                AutomationException
method BannerImageUrl

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getBannerImageUrl in interface IArcGISPortal
Returns:
The bsUrl
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
method Name

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getName in interface IArcGISPortal
Returns:
The bsName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isMultiTenant

public boolean isMultiTenant()
                      throws IOException,
                             AutomationException
method Name

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isMultiTenant in interface IArcGISPortal
Returns:
The isMulti
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.