NAME

PlugAuth::Role::Plugin - Role for PlugAuth plugins

VERSION

version 0.39

SYNOPSIS

 package PlugAuth::Plugin::MyPlugin;
 
 use Role::Tiny::With;
 
 with 'PlugAuth::Role::Plugin';
 
 sub init {
   my($self) = @_;
   # called immediately after plugin is
   # created.
 }
 
 1;

DESCRIPTION

Use this role when writing PlugAuth plugins.

OPTIONAL ABSTRACT METHODS

You may define these methods in your plugin.

$plugin->init

This method is called after the object is created.

METHODS

$plugin->global_config

Get the global PlugAuth configuration (an instance of Clustericious::Config).

$plugin->plugin_config

Get the plugin specific configuration. This method may be called as either an instance or class method.

$plugin->app

Returns the PlugAuth instance for the running PlugAuth server.

SEE ALSO

PlugAuth, PlugAuth::Guide::Plugin

AUTHOR

Graham Ollis <gollis@sesda3.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by NASA GSFC.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.