com.tibco.n2.service.adapter.binding

Interface EventCollectorUpdateService

All Known Implementing Classes:

EventCollectorUpdateService

public interface EventCollectorUpdateService

Interface to provide the EventCollectorUpdateService methods.

©2011 TIBCO Software Inc.

Method Summary

Modifier and Type	Method and Description
void	batchEvent(com.tibco.n2.ec.api.base.EventBatch eventBatch) Submit a batch of Events to the Event Collector database.
long	comment(com.tibco.n2.ec.api.base.Comment comment) Add a comment to the audit trail
void	errorEvent(com.tibco.n2.ec.api.base.Event event) Submit an error event to the Event Collector.
long	event(com.tibco.n2.ec.api.base.Event event) Submit an event to the Event Collector database.
com.tibco.n2.ec.api.base.AttributeDefinition[]	registerAttributes(long componentId, com.tibco.n2.ec.api.base.AttributeDefinition[] attributeDefinitionArray) Deprecated.
com.tibco.n2.ec.api.base.AttributeDefinition[]	registerAttributes(long componentId, com.tibco.n2.ec.api.base.AttributeDefinition[] attributeDefinitionArray, com.tibco.n2.ec.api.base.RegisterAttributeOptions registerAttributeOptions)
com.tibco.n2.ec.api.base.Component	registerComponent(com.tibco.n2.ec.api.base.Component component) Register a component or retrieve registration information on a previously registered component.
com.tibco.n2.ec.api.base.Environment	registerEnvironment(com.tibco.n2.ec.api.base.Environment environment) Register an environment.
com.tibco.n2.ec.api.base.Message[]	registerMessages(long componentId, com.tibco.n2.ec.api.base.Message[] messageArray, com.tibco.n2.ec.api.base.RegisterMessageOptions registerMessageOptions) Register messages for a component.

Method Detail

errorEvent

void errorEvent(com.tibco.n2.ec.api.base.Event event)

Submit an error event to the Event Collector.

Parameters:

event -

event

long event(com.tibco.n2.ec.api.base.Event event)
    throws com.tibco.n2.ec.services.SecurityFault

Submit an event to the Event Collector database. The event requires the attributes used to have been previously registered with Event Collector.

Parameters:

event -

Throws:

com.tibco.n2.ec.services.SecurityFault

batchEvent

void batchEvent(com.tibco.n2.ec.api.base.EventBatch eventBatch)

Submit a batch of Events to the Event Collector database. The event requires the attributes used to have been previously registered with Event Collector.

Parameters:

eventBatch -

registerAttributes

@Deprecated
com.tibco.n2.ec.api.base.AttributeDefinition[] registerAttributes(long componentId,
                                                                              com.tibco.n2.ec.api.base.AttributeDefinition[] attributeDefinitionArray)
                                                                       throws com.tibco.n2.ec.services.InvalidRequestFault,
                                                                              com.tibco.n2.ec.services.DuplicateRegistrationFault,
                                                                              com.tibco.n2.ec.services.InternalServiceFault,
                                                                              com.tibco.n2.ec.services.NoSuchComponentFault

Deprecated.

Register attributes registers a new set of attributes or retrieves attribute information for a previously registered set of attributes. A given component name/version can only have one set of attributes registered if this method finds that an existing set of attributes already exists it will confirm that it matches this set, and if so returns existing registration information. Otherwise an exception is thrown.

Parameters:

componentId -

attributeDefinitionArray -

Returns:

Throws:

com.tibco.n2.ec.services.InvalidRequestFault

com.tibco.n2.ec.services.DuplicateRegistrationFault

com.tibco.n2.ec.services.InternalServiceFault

com.tibco.n2.ec.services.NoSuchComponentFault

registerAttributes

com.tibco.n2.ec.api.base.AttributeDefinition[] registerAttributes(long componentId,
                                                                  com.tibco.n2.ec.api.base.AttributeDefinition[] attributeDefinitionArray,
                                                                  com.tibco.n2.ec.api.base.RegisterAttributeOptions registerAttributeOptions)
                                                           throws com.tibco.n2.ec.services.InvalidRequestFault,
                                                                  com.tibco.n2.ec.services.DuplicateRegistrationFault,
                                                                  com.tibco.n2.ec.services.InternalServiceFault,
                                                                  com.tibco.n2.ec.services.NoSuchComponentFault,
                                                                  com.tibco.n2.ec.services.SecurityFault

Throws:

com.tibco.n2.ec.services.InvalidRequestFault

com.tibco.n2.ec.services.DuplicateRegistrationFault

com.tibco.n2.ec.services.InternalServiceFault

com.tibco.n2.ec.services.NoSuchComponentFault

com.tibco.n2.ec.services.SecurityFault

registerComponent

com.tibco.n2.ec.api.base.Component registerComponent(com.tibco.n2.ec.api.base.Component component)
                                              throws com.tibco.n2.ec.services.DuplicateRegistrationFault,
                                                     com.tibco.n2.ec.services.InternalServiceFault,
                                                     com.tibco.n2.ec.services.SecurityFault

Register a component or retrieve registration information on a previously registered component. This method ensures no duplication/corruption of component information exists by ensuring that this component is either new or exactly matches an existing component (i.e. a given component name/version must contain the same information as a previously submitted component name/version which matches)

Parameters:

component -

Returns:

Throws:

com.tibco.n2.ec.services.DuplicateRegistrationFault

com.tibco.n2.ec.services.InternalServiceFault

com.tibco.n2.ec.services.SecurityFault

registerEnvironment

com.tibco.n2.ec.api.base.Environment registerEnvironment(com.tibco.n2.ec.api.base.Environment environment)
                                                  throws com.tibco.n2.ec.services.InternalServiceFault,
                                                         com.tibco.n2.ec.services.SecurityFault

Register an environment.

Parameters:

environment -

Returns:

Throws:

com.tibco.n2.ec.services.InternalServiceFault

com.tibco.n2.ec.services.SecurityFault

registerMessages

com.tibco.n2.ec.api.base.Message[] registerMessages(long componentId,
                                                    com.tibco.n2.ec.api.base.Message[] messageArray,
                                                    com.tibco.n2.ec.api.base.RegisterMessageOptions registerMessageOptions)
                                             throws com.tibco.n2.ec.services.InvalidRequestFault,
                                                    com.tibco.n2.ec.services.DuplicateRegistrationFault,
                                                    com.tibco.n2.ec.services.InternalServiceFault,
                                                    com.tibco.n2.ec.services.NoSuchComponentFault

Register messages for a component.

Parameters:

componentId -

messageArray -

Returns:

Throws:

com.tibco.n2.ec.services.InvalidRequestFault

com.tibco.n2.ec.services.DuplicateRegistrationFault

com.tibco.n2.ec.services.InternalServiceFault

com.tibco.n2.ec.services.NoSuchComponentFault

comment

long comment(com.tibco.n2.ec.api.base.Comment comment)
      throws com.tibco.n2.ec.services.InternalServiceFault,
             com.tibco.n2.ec.services.InvalidRequestFault,
             com.tibco.n2.ec.services.SecurityFault

Add a comment to the audit trail

Parameters:

comment -

Returns:

Throws:

com.tibco.n2.ec.services.InternalServiceFault

com.tibco.n2.ec.services.InvalidRequestFault

com.tibco.n2.ec.services.SecurityFault