Platform SDK Java 8.5 API Reference

com.genesyslab.platform.commons.protocol.auth
Class AuthTicketData

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.auth.AuthTicketData
All Implemented Interfaces:
AuthTicket, AuthTicketGSSSupport

public class AuthTicketData
extends java.lang.Object
implements AuthTicket, AuthTicketGSSSupport

An immutable ticket container. Used as a temporary storage for ticket data and associated metadata.


Constructor Summary
AuthTicketData(byte[] ticketBytes, boolean GSSTicket)
           
AuthTicketData(byte[] ticketBytes, java.lang.String servicePrincipalName, boolean GSSTicket)
           
AuthTicketData(byte[] ticketBytes, java.lang.String servicePrincipalName, java.lang.String userPrincipalName, boolean GSSTicket)
           
AuthTicketData(byte[] ticketBytes, java.lang.String servicePrincipalName, java.lang.String userPrincipalName, java.util.Date authTime, java.util.Date startTime, java.util.Date endTime, java.util.Date renewTill, boolean GSSTicket)
           
 
Method Summary
 java.util.Date getAuthTime()
          Gets the time that the client was authenticated.
 java.util.Date getEndTime()
          Gets the expiration time for this ticket's validity period.
 java.util.Date getRenewTill()
          Gets the latest expiration time for this ticket, including all renewals.
 java.lang.String getServicePrincipalName()
          Gets Service Principal Name (SPN) associated with this ticket.
 java.util.Date getStartTime()
          Gets the start time for this ticket's validity period.
 byte[] getTicketBytes()
          Gets Authentication ticket data, which is to be sent to server side.
 java.lang.String getTicketHex()
          Gets Hexadecimal uppercase string representation of ticket data.
 java.lang.String getUserPrincipalName()
          Gets User Principal Name (UPN) associated with this ticket.
 boolean isGSSTicket()
          Determines whether Kerberos ticket is wrapped by GSS.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AuthTicketData

public AuthTicketData(byte[] ticketBytes,
                      boolean GSSTicket)

AuthTicketData

public AuthTicketData(byte[] ticketBytes,
                      java.lang.String servicePrincipalName,
                      boolean GSSTicket)

AuthTicketData

public AuthTicketData(byte[] ticketBytes,
                      java.lang.String servicePrincipalName,
                      java.lang.String userPrincipalName,
                      boolean GSSTicket)

AuthTicketData

public AuthTicketData(byte[] ticketBytes,
                      java.lang.String servicePrincipalName,
                      java.lang.String userPrincipalName,
                      java.util.Date authTime,
                      java.util.Date startTime,
                      java.util.Date endTime,
                      java.util.Date renewTill,
                      boolean GSSTicket)
Method Detail

getUserPrincipalName

public java.lang.String getUserPrincipalName()
Description copied from interface: AuthTicket
Gets User Principal Name (UPN) associated with this ticket. UPN identifies user in the security realm being used.

Specified by:
getUserPrincipalName in interface AuthTicket
Returns:
User Principal Name (UPN) associated with this ticket. UPN identifies user in the security realm being used.

getServicePrincipalName

public java.lang.String getServicePrincipalName()
Description copied from interface: AuthTicket
Gets Service Principal Name (SPN) associated with this ticket. SPN identifies service in the security realm being used.

Specified by:
getServicePrincipalName in interface AuthTicket
Returns:
Service Principal Name (SPN) associated with this ticket. SPN identifies service in the security realm being used.

getTicketBytes

public byte[] getTicketBytes()
Description copied from interface: AuthTicket
Gets Authentication ticket data, which is to be sent to server side.

Specified by:
getTicketBytes in interface AuthTicket
Returns:
Authentication ticket data, which is to be sent to server side.

getTicketHex

public java.lang.String getTicketHex()
Description copied from interface: AuthTicket
Gets Hexadecimal uppercase string representation of ticket data.

Specified by:
getTicketHex in interface AuthTicket
Returns:
Hexadecimal uppercase string representation of ticket data.

getAuthTime

public java.util.Date getAuthTime()
Description copied from interface: AuthTicket
Gets the time that the client was authenticated.

Specified by:
getAuthTime in interface AuthTicket
Returns:
the time that the client was authenticated or null if not set.

getStartTime

public java.util.Date getStartTime()
Description copied from interface: AuthTicket
Gets the start time for this ticket's validity period.

Specified by:
getStartTime in interface AuthTicket
Returns:
the start time for this ticket's validity period or null if not set.

getEndTime

public java.util.Date getEndTime()
Description copied from interface: AuthTicket
Gets the expiration time for this ticket's validity period.

Specified by:
getEndTime in interface AuthTicket
Returns:
the expiration time for this ticket's validity period.

getRenewTill

public java.util.Date getRenewTill()
Description copied from interface: AuthTicket
Gets the latest expiration time for this ticket, including all renewals. This will return a null value for non-renewable tickets.

Specified by:
getRenewTill in interface AuthTicket
Returns:
the latest expiration time for this ticket.

isGSSTicket

public boolean isGSSTicket()
Description copied from interface: AuthTicketGSSSupport
Determines whether Kerberos ticket is wrapped by GSS.

Specified by:
isGSSTicket in interface AuthTicketGSSSupport
Returns:
true if Kerberos ticket is wrapped by GSS else false.

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.