Platform SDK Java 8.5 API Reference

com.genesyslab.platform.commons.protocol.auth
Interface AuthTicket

All Known Implementing Classes:
AuthTicketData

public interface AuthTicket

Defines basic authentication ticket properties.

See Also:
AuthTicketData

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.
 

Method Detail

getUserPrincipalName

java.lang.String getUserPrincipalName()
Gets User Principal Name (UPN) associated with this ticket. UPN identifies user in the security realm being used.

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

getServicePrincipalName

java.lang.String getServicePrincipalName()
Gets Service Principal Name (SPN) associated with this ticket. SPN identifies service in the security realm being used.

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

getTicketBytes

byte[] getTicketBytes()
Gets Authentication ticket data, which is to be sent to server side.

Returns:
Authentication ticket data, which is to be sent to server side.

getTicketHex

java.lang.String getTicketHex()
Gets Hexadecimal uppercase string representation of ticket data.

Returns:
Hexadecimal uppercase string representation of ticket data.

getAuthTime

java.util.Date getAuthTime()
Gets the time that the client was authenticated.

Returns:
the time that the client was authenticated or null if not set.

getStartTime

java.util.Date getStartTime()
Gets the start time for this ticket's validity period.

Returns:
the start time for this ticket's validity period or null if not set.

getEndTime

java.util.Date getEndTime()
Gets the expiration time for this ticket's validity period.

Returns:
the expiration time for this ticket's validity period.

getRenewTill

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

Returns:
the latest expiration time for this ticket.

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.