collections

Documentation

Index

• func Compare(correct, toTest *Collection) (bool, int, []string)
• type Collection
  • func NewCollection() *Collection
  • func (o *Collection) AddMediaType(s string) error
  • func (r *Collection) Compare(toTest *Collection) (bool, int, []string)
  • func (o *Collection) GetCanRead() bool
  • func (o *Collection) GetCanWrite() bool
  • func (o *Collection) SetCanRead() error
  • func (o *Collection) SetCanWrite() error
  • func (o *Collection) SetDisabled() error
  • func (o *Collection) SetEnabled() error
  • func (o *Collection) SetHidden() error
  • func (o *Collection) SetVisible() error
• type CollectionQuery
  • func NewCollectionQuery(id string, limit int) *CollectionQuery
• type CollectionQueryResult
• type Collections
  • func New() *Collections
  • func (o *Collections) AddCollection(c *Collection) (int, error)
  • func (o *Collections) NewCollection() (*Collection, error)

Functions

func Compare

func Compare(correct, toTest *Collection) (bool, int, []string)

Compare - This function will compare two collections to make sure they are the same. Collection correct is the master and represent the correct data, collection toTest represents the one we need to test.

Types

type Collection

type Collection struct {
	DatastoreID int    `json:"-"`
	DateAdded   string `json:"-"`
	Enabled     bool   `json:"-"`
	Hidden      bool   `json:"-"`
	Size        int    `json:"-"`
	properties.IDProperty
	properties.TitleProperty
	properties.DescriptionProperty
	CanRead    bool     `json:"can_read"`
	CanWrite   bool     `json:"can_write"`
	MediaTypes []string `json:"media_types,omitempty"`
}

Collection - This type implements the TAXII 2 Collection Resource and defines all of the properties and methods needed to create and work with the TAXII Collection Resource. All of the methods not defined local to this type are inherited from the individual properties.

DatastoreID = A unique integer that represents this collection DateAdded = The date that this collection was added to the system Enabled = Is this collection currently enabled Hidden = Is this collection currently hidden for the directory listing Size = The current size of the collection ID = The collection ID, a UUIDv4 value Title = The title of this collection Description = A long description about this collection CanRead = A boolean flag that indicates if one can read from this collection CanWrite = A boolean flag that indicates if one can write to this collection MediaTypes = A slice of strings of the media types that are found in this collection

The following information comes directly from the TAXII 2 specification documents.

This Endpoint provides general information about a Collection, which can be used to help users and clients decide whether and how they want to interact with it. For example, it will tell clients what it's called and what permissions they have to it.

The collection resource contains general information about a Collection, such as its id, a human-readable title and description, an optional list of supported media_types (representing the media type of objects can be requested from or added to it), and whether the TAXII Client, as authenticated, can get objects from the Collection and/or add objects to it.

func NewCollection

func NewCollection() *Collection

NewCollection - This function will create a new TAXII Collection object and return it as a pointer.

func (*Collection) AddMediaType

func (o *Collection) AddMediaType(s string) error

AddMediaType - This method takes in a string value that represents a version of the TAXII api that is supported and adds it to the list in media types property.

func (*Collection) Compare

func (r *Collection) Compare(toTest *Collection) (bool, int, []string)

Compare - This method will compare two collections to make sure they are the same. The collection receiver is the master and represent the correct data, the collection passed in as toTest represents the one we need to test.

func (*Collection) GetCanRead

func (o *Collection) GetCanRead() bool

GetCanRead - This method will return the value of Can Read.

func (*Collection) GetCanWrite

func (o *Collection) GetCanWrite() bool

GetCanWrite - This method will return the value of Can Write.

func (*Collection) SetCanRead

func (o *Collection) SetCanRead() error

SetCanRead - This method will set the can_read boolean to true.

func (*Collection) SetCanWrite

func (o *Collection) SetCanWrite() error

SetCanWrite - This method will set the can_write boolean to true.

func (*Collection) SetDisabled

func (o *Collection) SetDisabled() error

SetDisabled - This method will set the collection to be disabled.

func (*Collection) SetEnabled

func (o *Collection) SetEnabled() error

SetEnabled - This method will set the collection to be enabled.

func (*Collection) SetHidden

func (o *Collection) SetHidden() error

SetHidden - This method will set the collection to be hidden.

func (*Collection) SetVisible

func (o *Collection) SetVisible() error

SetVisible - This method will set the collection to be visible.

type CollectionQuery

type CollectionQuery struct {
	CollectionUUID        string
	CollectionDatastoreID int
	STIXID                []string // Passed in from the URL
	STIXType              []string // Passed in from the URL
	STIXVersion           []string // Passed in from the URL
	AddedAfter            []string // Passed in from the URL
	AddedBefore           []string // Passed in from the URL
	Limit                 []string // Passed in from the URL
	SpecVersion           []string // Passed in from the URL
	ServerRecordLimit     int      // Server defined value in the configuration file
}

CollectionQuery - This struct will hold all of the variables that a user can use to query a collection.

func NewCollectionQuery

func NewCollectionQuery(id string, limit int) *CollectionQuery

NewCollectionQuery - This function will take in a collection ID as a string and the Server Record Limit and return a CollectionQueryType object.

type CollectionQueryResult

type CollectionQueryResult struct {
	Size           int
	DateAddedFirst string
	DateAddedLast  string
	ObjectData     envelope.Envelope
	VersionsData   versions.Versions
	ManifestData   manifest.Manifest
}

CollectionQueryResult - This struct contains the various bits of meta data that are returned from a query against a collection on a TAXII server. This is done so that the method signatures do not need to change as time goes on and we add more meta data that needs to be returned. It is important to note that a collection may have more entries than the server or client wants to transmit. So it is important to keep track of which records are actually being delivered to the client.

Size = The total size of the dataset returned from the database query. DateAddedFirst = The added date of the first record being sent to the client. DateAddedLast = The added date of the last record being sent to the client. BundleData = The STIX bundle that contains the requested data from the collection. ManifestData = The TAXII manifest resource that contains the requested data from the collection. RangeBegin = The range value of the first record being sent to the client. RangeEnd = The range value of the last record being sent to the client.

type Collections

type Collections struct {
	Collections []Collection `json:"collections,omitempty" bson:"collections,omitempty"`
}

Collections - This type implements the TAXII 2 Collections Resource and defines all of the properties and methods needed to create and work with the TAXII Collections Resource. All of the methods not defined local to this type are inherited from the individual properties.

The following information comes directly from the TAXII 2 specification documents.

This Endpoint provides information about the Collections hosted under this API Root. This is similar to the response to get a Collection (see section 5.2), but rather than providing information about one Collection it provides information about all of the Collections. Most importantly, it provides the Collection's id, which is used to request objects or manifest entries from the Collection.

The collections resource is a simple wrapper around a list of collection resources.

func New

func New() *Collections

New - This function will create a new TAXII Collections object and return it as a pointer.

func (*Collections) AddCollection

func (o *Collections) AddCollection(c *Collection) (int, error)

AddCollection - This method takes in an object that represents a collection and adds it to the list in the collections property and returns an integer of the location in the slice where the collection object was added. This method would be used if the collection was created separately and it just needs to be added in whole to the collections list.

func (*Collections) NewCollection

func (o *Collections) NewCollection() (*Collection, error)

NewCollection - This method is used to create a collection and automatically add it to the collections array. It returns a resources.Collection which is a pointer to the actual Collection that was created in the collections slice.