Difference between revisions of "API:EPrints/DataObj/LoginTicket"

From EPrints Documentation
Jump to: navigation, search
Line 1: Line 1:
 
<!-- Pod2Wiki=_preamble_  
 
<!-- Pod2Wiki=_preamble_  
−
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
+
This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
−
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/DataObj/LoginTicket.pm|package_name=EPrints::DataObj::LoginTicket}}[[Category:API|LOGINTICKET]][[Category:API:EPrints/DataObj|LOGINTICKET]][[Category:API:EPrints/DataObj/LoginTicket|LOGINTICKET]]<div><!-- Edit below this comment -->
+
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/DataObj/LoginTicket.pm|package_name=EPrints::DataObj::LoginTicket}}[[Category:API|LOGINTICKET]][[Category:API:EPrints/DataObj|LOGINTICKET]]<div><!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 
==NAME==
 
==NAME==
−
'''EPrints::DataObj::LoginTicket''' - user system loginticket
+
'''EPrints::DataObj::LoginTicket''' - User system loginticket
  
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 +
</div>
 
<!-- Pod2Wiki=head_description -->
 
<!-- Pod2Wiki=head_description -->
 
==DESCRIPTION==
 
==DESCRIPTION==
 
Login tickets are the database entries for the user's session cookies.
 
Login tickets are the database entries for the user's session cookies.
  
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 +
</div>
 
<!-- Pod2Wiki=head_configuration_settings -->
 
<!-- Pod2Wiki=head_configuration_settings -->
 
===Configuration Settings===
 
===Configuration Settings===
−
* user_cookie_timeout = undef
+
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
−
: Set an expiry on the session cookies. This will cause the user's browser to delete the cookie after the given time. The time is specified according to {{API:PodLink|file=CGI|package_name=CGI|section=|text=CGI}}'s cookie constructor. This allows settings like <code>+1h</code> and <code>+7d</code>.
+
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_user_cookie_timeout_undef -->
 +
====user_cookie_timeout = undef====
 +
 
 +
Set an expiry on the session cookies. This will cause the user's browser to delete the cookie after the given time. The time is specified according to {{API:PodLink|file=CGI|package_name=CGI|section=|text=CGI}}'s cookie constructor. This allows settings like <tt>+1h</tt> and <tt>+7d</tt>.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_user_inactivity_timeout_86400_7 -->
 +
====user_inactivity_timeout = 86400 * 7====
 +
 
 +
How long to wait in seconds before logging the user out after their  last activity.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_user_session_timeout_undef -->
 +
====user_session_timeout = undef====
 +
 
 +
How long in seconds the user can stay logged in before they must  re-log in. Defaults to never - if you do specify this setting you  probably want to reduce <tt>user_inactivity_timeout</tt> to &lt;1 hour.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_core_metadata_fields -->
 +
==CORE METADATA FIELDS==
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
  
−
* user_inactivity_timeout = 86400 * 7
 
−
: How long to wait in seconds before logging the user out after their last activity.
 
  
−
* user_session_timeout = undef
+
<!-- Pod2Wiki= -->
−
: How long in seconds the user can stay logged in before they must re-log in. Defaults to never - if you do specify this setting you probably want to reduce user_inactivity_timeout to &lt;1 hour.
+
</div>
 +
<!-- Pod2Wiki=item_code -->
 +
===code (id)===
 +
 
 +
The identifier used in the HTTP cookie for this login ticket's  session.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_securecode -->
 +
===securecode (id)===
 +
 
 +
The identifier used in the HTTPS cookie for this login ticket's  session.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_ip -->
 +
===ip (id)===
 +
 
 +
The IP address of associated with this login ticket.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_time -->
 +
===time (bigint)===
 +
 
 +
The time in seconds since the start of epoch when this login  ticket was created.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_expires -->
 +
===expires (bigint)===
 +
 
 +
The time in seconds since the start of epoch when this login ticket will expires.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_references_and_related_objects -->
 +
==REFERENCES AND RELATED OBJECTS==
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_userid -->
 +
===userid (itemref)===
 +
 
 +
The ID of the user to whom this login ticket belongs.
  
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 +
</div>
 
<!-- Pod2Wiki=head_methods -->
 
<!-- Pod2Wiki=head_methods -->
 
==METHODS==
 
==METHODS==
−
<!-- Pod2Wiki=head_get_system_field_info -->
+
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_get_system_field_info -->
 
===get_system_field_info===
 
===get_system_field_info===
  
−
<source lang="perl">$thing = EPrints::DataObj::Access->get_system_field_info
+
$fields = EPrints::DataObj::Access-&gt;get_system_field_info
 +
Returns an array describing the system metadata of the loginticket dataset.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_get_dataset_id -->
 +
===get_dataset_id===
 +
 
 +
$dataset = EPrints::DataObj::LoginTicket-&gt;get_dataset_id
 +
Returns the ID of the [[API:EPrints/DataSet|EPrints::DataSet]] object to which this record  belongs.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_get_defaults -->
 +
===get_defaults===
  
−
</source>
+
$defaults = EPrints::DataObj::LoginTicket-&gt;get_defaults( $session, $data, $dataset )
−
Core fields.
+
Returns default values for this data object based on the starting <tt>$data</tt>.
  
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=head_class_methods -->
+
</div>
−
===Class Methods===
+
<!-- Pod2Wiki=item_new_from_request -->
 +
===new_from_request===
 +
 
 +
$loginticket = EPrints::DataObj::LoginTicket-&gt;new_from_request( $repo, $r )
 +
Creates a new loginticket data object using the {{API:PodLink|file=HTTP/Request|package_name=HTTP::Request|section=|text=HTTP::Request}}  <tt>$r</tt>.
 +
 
 +
Returns new loginticket data object if successful. Otherwise, returns <tt>undef</tt>.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=head_get_dataset_id -->
+
</div>
−
===get_dataset_id===
+
<!-- Pod2Wiki=item_expire_all -->
 +
===expire_all===
 +
 
 +
EPrints::DataObj::LoginTicket-&gt;expire_all( $repo )
 +
Expire all login tickets. Effectively logging out all users currently logged in.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_session_key -->
 +
===session_key===
 +
 
 +
EPrints::DataObj::LoginTicket-&gt;session_key( $repo )
 +
Get the key to use for the session cookies.
 +
 
 +
In the following circumstance:
 +
 
 +
  example.org
 +
  custom.example.org
 +
 
 +
Where both hosts use the same cookie key the cookie from example.org  will collide with the cookie from custom.example.org. To avoid this  the full hostname is embedded in the cookie key.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
  
−
<source lang="perl">$dataset = EPrints::DataObj::LoginTicket->get_dataset_id
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_secure_session_key -->
 +
===secure_session_key===
  
−
</source>
+
EPrints::DataObj::LoginTicket-&gt;secure_session_key($repo)
−
Returns the id of the [[API:EPrints/DataSet|EPrints::DataSet]] object to which this record belongs.
+
See [[API:EPrints/DataObj/LoginTicket#session_key|session_key]].
  
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 +
</div>
 
<!-- Pod2Wiki=head_object_methods -->
 
<!-- Pod2Wiki=head_object_methods -->
 
===Object Methods===
 
===Object Methods===
−
  $ticket-&gt;set_cookies()
+
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
−
Set the session cookies for this login ticket.
+
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
  
−
$ticket-&gt;update()
+
<!-- Pod2Wiki= -->
−
Update the login ticket by increasing the expiry time.
+
</div>
 +
<!-- Pod2Wiki=item_generate_cookie -->
 +
====generate_cookie====
  
−
The expiry time is increased <code>user_inactivity_timeout</code> or 7 days.
+
$cookie = $loginticket-&gt;generate_cookie( %opts )
 +
Returns the HTTP (non-secure) session cookie. Uses <tt>%opts</tt> to add any additional attributes to the cookie.
  
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=head_see_also -->
+
</div>
−
==SEE ALSO==
+
<!-- Pod2Wiki=item_generate_secure_cookie -->
−
[[API:EPrints/DataObj|EPrints::DataObj]] and [[API:EPrints/DataSet|EPrints::DataSet]].
+
====generate_secure_cookie====
 +
 
 +
$cookie = $ticket-&gt;generate_secure_cookie( %opts )
 +
Returns the HTTPS session cookie. Uses <tt>%opts</tt> to add any additional  attributes to the cookie.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_set_cookies -->
 +
====set_cookies====
 +
 
 +
$ticket-&gt;set_cookies
 +
Set the session cookies for this loginticket data object.
  
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=head_copyright -->
+
</div>
−
==COPYRIGHT==
+
<!-- Pod2Wiki=item_update -->
−
Copyright 2000-2011 University of Southampton.
+
====update====
  
−
This file is part of EPrints http://www.eprints.org/.
+
$ticket-&gt;update
 +
Update the loginticket data object by extending the expiry time.
  
−
EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
The expiry time is extended <tt>user_inactivity_timeout</tt> or 7 days.
  
−
EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
+
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
  
−
You should have received a copy of the GNU Lesser General Public License along with EPrints.  If not, see http://www.gnu.org/licenses/.
 
  
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_see_also -->
 +
==SEE ALSO==
 +
[[API:EPrints/DataObj|EPrints::DataObj]] and [[API:EPrints/DataSet|EPrints::DataSet]].
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=_postamble_ -->
+
</div>
 +
<!-- Pod2Wiki=head_copyright -->
 +
==COPYRIGHT==
 +
{{API:Copyright}}
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

Revision as of 00:13, 30 December 2021

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::DataObj::LoginTicket - User system loginticket

User Comments


DESCRIPTION

Login tickets are the database entries for the user's session cookies.

User Comments


Configuration Settings

User Comments


user_cookie_timeout = undef

Set an expiry on the session cookies. This will cause the user's browser to delete the cookie after the given time. The time is specified according to CGI's cookie constructor. This allows settings like +1h and +7d.

User Comments


user_inactivity_timeout = 86400 * 7

How long to wait in seconds before logging the user out after their last activity.

User Comments


user_session_timeout = undef

How long in seconds the user can stay logged in before they must re-log in. Defaults to never - if you do specify this setting you probably want to reduce user_inactivity_timeout to <1 hour.

User Comments


CORE METADATA FIELDS

User Comments


code (id)

The identifier used in the HTTP cookie for this login ticket's session.

User Comments


securecode (id)

The identifier used in the HTTPS cookie for this login ticket's session.

User Comments


ip (id)

The IP address of associated with this login ticket.

User Comments


time (bigint)

The time in seconds since the start of epoch when this login ticket was created.

User Comments


expires (bigint)

The time in seconds since the start of epoch when this login ticket will expires.

User Comments


REFERENCES AND RELATED OBJECTS

User Comments


userid (itemref)

The ID of the user to whom this login ticket belongs.

User Comments


METHODS

User Comments


get_system_field_info

$fields = EPrints::DataObj::Access->get_system_field_info

Returns an array describing the system metadata of the loginticket dataset.

User Comments


get_dataset_id

$dataset = EPrints::DataObj::LoginTicket->get_dataset_id

Returns the ID of the EPrints::DataSet object to which this record belongs.

User Comments


get_defaults

$defaults = EPrints::DataObj::LoginTicket->get_defaults( $session, $data, $dataset )

Returns default values for this data object based on the starting $data.

User Comments


new_from_request

$loginticket = EPrints::DataObj::LoginTicket->new_from_request( $repo, $r )

Creates a new loginticket data object using the HTTP::Request $r.

Returns new loginticket data object if successful. Otherwise, returns undef.

User Comments


expire_all

EPrints::DataObj::LoginTicket->expire_all( $repo )

Expire all login tickets. Effectively logging out all users currently logged in.

User Comments


session_key

EPrints::DataObj::LoginTicket->session_key( $repo )

Get the key to use for the session cookies.

In the following circumstance: 

 example.org
 custom.example.org

Where both hosts use the same cookie key the cookie from example.org will collide with the cookie from custom.example.org. To avoid this the full hostname is embedded in the cookie key.

User Comments


secure_session_key

EPrints::DataObj::LoginTicket->secure_session_key($repo)

See session_key.

User Comments


Object Methods

User Comments


generate_cookie

$cookie = $loginticket->generate_cookie( %opts )

Returns the HTTP (non-secure) session cookie. Uses %opts to add any additional attributes to the cookie.

User Comments


generate_secure_cookie

$cookie = $ticket->generate_secure_cookie( %opts )

Returns the HTTPS session cookie. Uses %opts to add any additional attributes to the cookie.

User Comments


set_cookies

$ticket->set_cookies

Set the session cookies for this loginticket data object.

User Comments


update

$ticket->update

Update the loginticket data object by extending the expiry time.

The expiry time is extended user_inactivity_timeout or 7 days.

User Comments


SEE ALSO

EPrints::DataObj and EPrints::DataSet.

User Comments


COPYRIGHT

© Copyright 2000-2024 University of Southampton.

EPrints 3.4 is supplied by EPrints Services.

http://www.eprints.org/eprints-3.4/

LICENSE

This file is part of EPrints 3.4 http://www.eprints.org/.

EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.

EPrints 3.4 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints 3.4. If not, see http://www.gnu.org/licenses/.

User Comments


Retrieved from ‘https://wiki.eprints.org/w/index.php?title=API:EPrints/DataObj/LoginTicket&oldid=14017’