Difference between revisions of "API:EPrints/Apache/LogHandler"

From EPrints Documentation
Jump to: navigation, search
(New page: <!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost. -...)
 
(Removing all content from page)
Line 1: Line 1:
<!-- Pod2Wiki=_preamble_
 
This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
 
-->{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/LogHandler.pm|package_name=EPrints::Apache::LogHandler}}[[Category:API|LogHandler]]<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_name -->=NAME=
 
EPrints::Apache::LogHandler - Main handler for Apache log events
 
  
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_configuration -->=CONFIGURATION=
 
To enable the Apache::LogHandler add to your ArchiveConfig:
 
 
  $c-&gt;{loghandler}-&gt;{enable} = 1;
 
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_data_format -->=DATA FORMAT=
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_requester -->==requester==
 
 
The requester is stored using their IP in URN format: <tt>urn:ip:x.x.x.x</tt>.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_servicetype -->==servicetype==
 
 
  serviceType
 
 
ServiceType is in format {{API:PodLink|file=http:|package_name=http:|section=|text=info:ofi/fmt:kev:mtx:sch_svc}}.
 
 
The value is encoded as <tt>?name=yes</tt> (where <tt>name</tt> is one of the services defined).
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_referent_referringentity -->==referent_referringentity==
 
 
  referent, referringEntity
 
 
These are stored in URN format: <tt>info:oai:repositoryid:eprintid</tt>.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_referent_docid -->==referent_docid==
 
 
The document id as a fragment of the referent: <tt>#docid</tt>.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_methods -->=METHODS=
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_handler -->==handler==
 
 
  handler REQUEST
 
 
Called by mod_perl whenever a request is made to the web server where REQUEST is an Apache Request object.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_uri_to_eprintid -->==uri_to_eprintid==
 
 
  $id = EPrints::Apache::LogHandler::uri_to_eprintid( $session, $uri )
 
 
Returns the eprint id that $uri corresponds to, or undef.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_uri_to_docid -->==uri_to_docid==
 
 
  $id = EPrints::Apache::LogHandler::uri_to_docid( $session, $eprintid, $uri )
 
 
Returns the docid that $uri corresponds to (given the $eprintid), or undef.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_see_also -->=SEE ALSO=
 
[[API:EPrints/DataObj/Access|EPrints::DataObj::Access]]
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
 

Revision as of 15:40, 12 August 2009