Documentation ¶
Index ¶
- Constants
- Variables
- func GetInfoController() martini.Handler
- func GetTaskByIDController(taskServiceURI string, collectionDialer integrations.CollectionDialer) martini.Handler
- func InitRoutes(m *martini.ClassicMartini, keyCheckHandler martini.Handler, appEnv *cfenv.App)
- func ParseURL(url string) (*mgo.DialInfo, error)
- type MongoCollection
- type MongoCollectionGetter
- type MongoCollectionWrapper
- type Persistence
- type Task
Constants ¶
const ( //TaskCollectionName - collection name for tasks TaskCollectionName = "dispenser_tasks" //SuccessStatusResponseTaskByID - success statuscode for gettaskbyidcontroller SuccessStatusResponseTaskByID = 200 //FailureStatusResponseTaskByID - failure statuscode for gettaskbyidcontroller FailureStatusResponseTaskByID = 404 )
const (
//APIVersion1 - version 1 const
APIVersion1 = "v1"
)
Variables ¶
var ( //ErrNoMatchInStore - error when there is no matching org in the datastore ErrNoMatchInStore = errors.New("Could not find a matching user org or connection failure") //ErrCanNotAddOrgRec - error when we can not add a new org record to the datastore ErrCanNotAddOrgRec = errors.New("Could not add a new org record") )
var ( //URLBaseV1 - v1 url path base URLBaseV1 = fmt.Sprintf("/%s", APIVersion1) )
Functions ¶
func GetInfoController ¶ added in v0.0.48
GetInfoController - this is the controller to handle a info call to the api
func GetTaskByIDController ¶ added in v0.0.49
func GetTaskByIDController(taskServiceURI string, collectionDialer integrations.CollectionDialer) martini.Handler
GetTaskByIDController - this is the controller to handle a get task call
func InitRoutes ¶
func InitRoutes(m *martini.ClassicMartini, keyCheckHandler martini.Handler, appEnv *cfenv.App)
InitRoutes - initialize the mappings for controllers against valid routes
Types ¶
type MongoCollection ¶ added in v0.0.23
type MongoCollection interface { Remove(selector interface{}) error Find(query interface{}) *mgo.Query Upsert(selector interface{}, update interface{}) (info *mgo.ChangeInfo, err error) }
MongoCollection - interface to a collection in mongo
type MongoCollectionGetter ¶ added in v0.0.23
type MongoCollectionGetter interface {
Collection() Persistence
}
MongoCollectionGetter - Getting collections in mongo
type MongoCollectionWrapper ¶ added in v0.0.23
type MongoCollectionWrapper struct { Persistence // contains filtered or unexported fields }
MongoCollectionWrapper - interface to wrap mongo collections with additional persistence functions
func (*MongoCollectionWrapper) FindOne ¶ added in v0.0.23
func (s *MongoCollectionWrapper) FindOne(query interface{}, result interface{}) (err error)
FindOne - combining the Find and One calls of a Mongo collection object
func (*MongoCollectionWrapper) Remove ¶ added in v0.0.23
func (s *MongoCollectionWrapper) Remove(selector interface{}) error
Remove - removes the matching selector from collection
func (*MongoCollectionWrapper) Upsert ¶ added in v0.0.23
func (s *MongoCollectionWrapper) Upsert(selector interface{}, update interface{}) (err error)
Upsert - allow us to call upsert on Mongo collection object
type Persistence ¶ added in v0.0.23
type Persistence interface { Remove(selector interface{}) error FindOne(query interface{}, result interface{}) (err error) Upsert(selector interface{}, update interface{}) (err error) }
Persistence - interface to a persistence store of some kind
func NewMongoCollectionWrapper ¶ added in v0.0.23
func NewMongoCollectionWrapper(c MongoCollection) Persistence
NewMongoCollectionWrapper - wraps a Mongo collection in as a Peristence interface implementation