com.plumtree.server
Interface IPTSSOInfo


public interface IPTSSOInfo

Used to store information which will be sent in portlet and gateway requests.


Method Summary
 void AddOneSecureHeader(java.lang.String bstrSecureHeader)
          Adds a header not to forward in requests.
 void AddSecureSessionCookie(java.lang.String bstrCookieName, java.lang.String bstrCookieValue, com.plumtree.openfoundation.util.XPDateTime dtExpires, java.lang.String bstrPath, java.lang.String bstrDomain, boolean bSecure)
          Adds a single cookie.
 java.lang.String GetBasicAuthName()
          Returns the username to use for Basic Auth headers.
 java.lang.String GetBasicAuthPassword()
          Returns the password to use for Basic Auth headers.
 IPTCookieInfo GetCookieOfIndex(int lIndex)
          Returns information about a single cookie.
 java.lang.Object[] GetSecureHeaders()
          Returns a list of headers not to forward in requests.
 int GetTotalNumCookies()
          Returns the total number of cookies to send.
 void SetBasicAuthName(java.lang.String Value)
          Sets the username to use for Basic Auth headers.
 void SetBasicAuthPassword(java.lang.String Value)
          Sets the password to use for Basic Auth headers.
 

Method Detail

GetBasicAuthName

public java.lang.String GetBasicAuthName()
Returns the username to use for Basic Auth headers.
Returns:
the username

SetBasicAuthName

public void SetBasicAuthName(java.lang.String Value)
Sets the username to use for Basic Auth headers.
Parameters:
Value - the username

GetBasicAuthPassword

public java.lang.String GetBasicAuthPassword()
Returns the password to use for Basic Auth headers.
Returns:
the password

SetBasicAuthPassword

public void SetBasicAuthPassword(java.lang.String Value)
Sets the password to use for Basic Auth headers.
Parameters:
Value - the password

GetTotalNumCookies

public int GetTotalNumCookies()
Returns the total number of cookies to send.
Returns:
the number of cookies

GetCookieOfIndex

public IPTCookieInfo GetCookieOfIndex(int lIndex)
Returns information about a single cookie.
Parameters:
lIndex - index of the cookie
Returns:
IPTCookieInfo

AddSecureSessionCookie

public void AddSecureSessionCookie(java.lang.String bstrCookieName,
                                   java.lang.String bstrCookieValue,
                                   com.plumtree.openfoundation.util.XPDateTime dtExpires,
                                   java.lang.String bstrPath,
                                   java.lang.String bstrDomain,
                                   boolean bSecure)
Adds a single cookie.
Parameters:
bstrCookieName - cookie name
bstrCookieValue - cookie value
dtExpires - cookie expiration
bstrPath - cookie path
bstrDomain - cookie domain
bSecure - whether cookie is sent over https only

GetSecureHeaders

public java.lang.Object[] GetSecureHeaders()
Returns a list of headers not to forward in requests.
Returns:
array of header prefixes

AddOneSecureHeader

public void AddOneSecureHeader(java.lang.String bstrSecureHeader)
Adds a header not to forward in requests.
Parameters:
bstrSecureHeader - a header prefix


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.