forked from muesli/beehive
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cronbeefactory.go
128 lines (115 loc) · 3.42 KB
/
cronbeefactory.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
/*
* Copyright (C) 2014 Stefan 'glaxx' Luecke
* 2014-2017 Christian Muehlhaeuser
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Authors:
* Stefan Luecke <glaxx@glaxx.net>
* Christian Muehlhaeuser <muesli@gmail.com>
*/
package cronbee
import (
"github.com/muesli/beehive/bees"
)
// CronBeeFactory is a factory for CronBees.
type CronBeeFactory struct {
bees.BeeFactory
}
// New returns a new Bee instance configured with the supplied options.
func (factory *CronBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface {
bee := CronBee{
Bee: bees.NewBee(name, factory.ID(), description, options),
}
bee.ReloadOptions(options)
return &bee
}
// ID returns the ID of this Bee.
func (factory *CronBeeFactory) ID() string {
return "cronbee"
}
// Name returns the name of this Bee.
func (factory *CronBeeFactory) Name() string {
return "Cron"
}
// Description returns the description of this Bee.
func (factory *CronBeeFactory) Description() string {
return "Triggers events at given intervals"
}
// Image returns the filename of an image for this Bee.
func (factory *CronBeeFactory) Image() string {
return factory.ID() + ".png"
}
// LogoColor returns the preferred logo background color (used by the admin interface).
func (factory *CronBeeFactory) LogoColor() string {
return "#aaaaaa"
}
// Options returns the options available to configure this Bee.
func (factory *CronBeeFactory) Options() []bees.BeeOptionDescriptor {
opts := []bees.BeeOptionDescriptor{
{
Name: "second",
Description: "00-59 for a specific second; * for ignore",
Type: "string",
},
{
Name: "minute",
Description: "00-59 for a specific minute; * for ignore",
Type: "string",
},
{
Name: "hour",
Description: "00-23 for a specific hour; * for ignore",
Type: "string",
},
{
Name: "day_of_week",
Description: "0-6 0 = Sunday 6 = Saturday; * for ignore",
Type: "string",
},
{
Name: "day_of_month",
Description: "01-31 for a specific day of the month; * for ignore",
Type: "string",
},
{
Name: "month",
Description: "01 - 12 for a specific month; * for ignore",
Type: "string",
},
}
return opts
}
// Events describes the available events provided by this Bee.
func (factory *CronBeeFactory) Events() []bees.EventDescriptor {
events := []bees.EventDescriptor{
{
Namespace: factory.Name(),
Name: "time",
Description: "The time has come ...",
Options: []bees.PlaceholderDescriptor{
{
Name: "timestamp",
Description: "Timestamp of the next event",
Type: "string",
},
},
},
}
return events
}
func init() {
f := CronBeeFactory{}
bees.RegisterFactory(&f)
}