de.fhhannover.inform.trust.ifmapj.metadata
Class StandardIfmapMetadataFactoryImpl

java.lang.Object
  extended by de.fhhannover.inform.trust.ifmapj.metadata.StandardIfmapMetadataFactoryImpl
All Implemented Interfaces:
StandardIfmapMetadataFactory

public class StandardIfmapMetadataFactoryImpl
extends Object
implements StandardIfmapMetadataFactory

Simple implementation of the StandardIfmapMetadataFactory interface.

Author:
aw, ib

Constructor Summary
StandardIfmapMetadataFactoryImpl()
           
 
Method Summary
 Document createArDev()
          Create a Document representing access-request-device metadata.
 Document createArIp()
          Create a Document representing access-request-ip metadata.
 Document createArMac()
          Create a Document representing access-request-mac metadata.
 Document createAuthAs()
          Create a Document representing authenticated-as metadata.
 Document createAuthBy()
          Create a Document representing authenticated-by metadata.
 Document createCapability(String name)
          Create a Document representing capability metadata.
 Document createCapability(String name, String administrativeDomain)
          Create a Document representing capability metadata.
 Document createDevAttr(String name)
          Create a Document representing device-attribute metadata.
 Document createDevChar(String manufacturer, String model, String os, String osVersion, String deviceType, String discoveredTime, String discovererId, String discoveryMethod)
          Create a Document representing device-characteristic metadata.
 Document createDevIp()
          Create a Document representing device-ip metadata.
 Document createDiscoveredBy()
          Create a Document representing discovered-by metadata.
 Document createEnforcementReport(EnforcementAction enforcementAction, String otherTypeDefinition, String enforcementReason)
          Create a Document representing enforcement-report metadata.
 Document createEvent(String name, String discoveredTime, String discovererId, Integer magnitude, Integer confidence, Significance significance, EventType type, String otherTypeDefinition, String information, String vulnerabilityUri)
          Create a Document representing event metadata.
 Document createIpMac()
          Create a Document representing ip-mac metadata.
 Document createIpMac(String startTime, String endTime, String dhcpServer)
          Create a Document representing ip-mac metadata based on the given parameters.
 Document createLayer2Information(Integer vlanNum, String vlanName, Integer port, String administrativeDomain)
          Create a Document representing layer2-information metadata.
 Document createLocation(List<LocationInformation> locationInformation, String discoveredTime, String discovererId)
          Create a Document representing location metadata.
 Document createRequestForInvestigation(String qualifier)
          Create a Document representing request-for-investigation metadata.
 Document createRole(String name)
          Create a Document representing role metadata.
 Document createRole(String name, String administrativeDomain)
          Create a Document representing role metadata.
 Document createUnexpectedBehavior(String discoveredTime, String discovererId, Integer magnitude, Integer confidence, Significance significance, String type)
          Create a Document representing unexpected-behavior metadata.
 Document createWlanInformation(String ssid, List<WlanSecurityType> ssidUnicastSecurity, WlanSecurityType ssidGroupSecurity, List<WlanSecurityType> ssidManagementSecurity)
          Create a Document representing wlan-information metadata.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StandardIfmapMetadataFactoryImpl

public StandardIfmapMetadataFactoryImpl()
Method Detail

createIpMac

public Document createIpMac(String startTime,
                            String endTime,
                            String dhcpServer)
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing ip-mac metadata based on the given parameters.
  ip-mac is link metadata that associates an
  ip-address identifier with a mac-address identifier
  and which includes optional DHCP lease information
 

Specified by:
createIpMac in interface StandardIfmapMetadataFactory
Parameters:
startTime - the start-time value or null
endTime - the end-time value or null
dhcpServer - the dhcp-server value or null
Returns:
a Document that represents the metadata

createIpMac

public Document createIpMac()
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing ip-mac metadata.
  ip-mac is link metadata that associates an
  ip-address identifier with a mac-address identifier
  and which includes optional DHCP lease information
 

Specified by:
createIpMac in interface StandardIfmapMetadataFactory
Returns:
a Document that represents the metadata

createArMac

public Document createArMac()
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing access-request-mac metadata.
  access-request-mac is link metadata that
  associates an access-request identifier with
  a mac-address identifier 
 

Specified by:
createArMac in interface StandardIfmapMetadataFactory
Returns:
a Document that represents the metadata

createArDev

public Document createArDev()
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing access-request-device metadata.
  access-request-device is link metadata that
  associates an access-request identifier with
  a device identifier
 

Specified by:
createArDev in interface StandardIfmapMetadataFactory
Returns:
a Document that represents the metadata

createArIp

public Document createArIp()
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing access-request-ip metadata.
  access-request-ip is link metadata that
  associates an access-request identifier with
  an ip-address identifier
 

Specified by:
createArIp in interface StandardIfmapMetadataFactory
Returns:
a Document that represents the metadata

createAuthAs

public Document createAuthAs()
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing authenticated-as metadata.
  authenticated-as is link metadata that
  associates an access-request identifier with
  an identity identifier
 

Specified by:
createAuthAs in interface StandardIfmapMetadataFactory
Returns:
a Document that represents the metadata

createAuthBy

public Document createAuthBy()
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing authenticated-by metadata.
  authenticated-by is link metadata that
  associates an access-request identifier with
  the device identifier of the PDP that
  authenticated the access-request 
 

Specified by:
createAuthBy in interface StandardIfmapMetadataFactory
Returns:
a Document that represents the metadata

createDevIp

public Document createDevIp()
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing device-ip metadata.
  device-ip is link metadata that associates a device
  identifier of a PDP with an IP address which it has
  authenticated 
 

Specified by:
createDevIp in interface StandardIfmapMetadataFactory
Returns:
a Document that represents the metadata

createDiscoveredBy

public Document createDiscoveredBy()
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing discovered-by metadata.
  discovered-by is link metadata that associates
  an ip-address or mac-address identifier of an endpoint
  with the device identifier of a MAP Client that has
  noticed the endpoint on the network 
 

Specified by:
createDiscoveredBy in interface StandardIfmapMetadataFactory
Returns:
a Document that represents the metadata

createRole

public Document createRole(String name,
                           String administrativeDomain)
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing role metadata.
  role is link metadata that associates an
  access-request identifier with an identity
  identifier and which names collections of
  privileges associated with the end-user
 

Specified by:
createRole in interface StandardIfmapMetadataFactory
Parameters:
name - the name of the role
administrativeDomain - the administrative-domain or null
Returns:
a Document that represents the metadata

createRole

public Document createRole(String name)
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing role metadata.
  role is link metadata that associates an
  access-request identifier with an identity
  identifier and which names collections of
  privileges associated with the end-user
 

Specified by:
createRole in interface StandardIfmapMetadataFactory
Returns:
a Document that represents the metadata

createDevAttr

public Document createDevAttr(String name)
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing device-attribute metadata.
  device-attribute is link metadata that associates
  an access-request identifier with a device identifier
  and which includes information about the device such
  as its health 
 

Specified by:
createDevAttr in interface StandardIfmapMetadataFactory
Parameters:
name - the name of the attribute
Returns:
a Document that represents the metadata

createCapability

public Document createCapability(String name,
                                 String administrativeDomain)
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing capability metadata.
  capability metadata refers to a collection of privileges
  assigned to an endpoint as a result of an access request.
 

Specified by:
createCapability in interface StandardIfmapMetadataFactory
Parameters:
name - the name of the capability
administrativeDomain - the administrative-domain or null
Returns:
a Document that represents the metadata

createCapability

public Document createCapability(String name)
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing capability metadata.
  capability metadata refers to a collection of privileges
  assigned to an endpoint as a result of an access request.
 

Specified by:
createCapability in interface StandardIfmapMetadataFactory
Parameters:
name - the name of the capability
Returns:
a Document that represents the metadata

createDevChar

public Document createDevChar(String manufacturer,
                              String model,
                              String os,
                              String osVersion,
                              String deviceType,
                              String discoveredTime,
                              String discovererId,
                              String discoveryMethod)
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing device-characteristic metadata.
   device-characteristic is metadata assigned to a specific endpoint
   by a MAP Client (usually a PDP or Sensor) to reflect an inherent
   characteristic of that endpoint, such as its manufacturer or what
   operating system it is running, along with what element discovered
   the information and what method of discovery was used.
 

Specified by:
createDevChar in interface StandardIfmapMetadataFactory
Parameters:
manufacturer - the manufacturer of the endpoint
model - the model of the endpoint
os - the operating system of the endpoint
osVersion - the version of the endpoint's operating system
deviceType - the type of the endpoint
discoveredTime - (mandatory) the time at which this device-characteristic was first detected
discovererId - (mandatory)
discoveryMethod - (mandatory) the element that discovered the characteristic
Returns:
a Document that represents the metadata

createEnforcementReport

public Document createEnforcementReport(EnforcementAction enforcementAction,
                                        String otherTypeDefinition,
                                        String enforcementReason)
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing enforcement-report metadata.
   enforcement-report metadata is attached to a link to associate a
   specific mac-address identifier or ip-address identifier with a
   specific device identifier representing a PEP or Flow Controller.
   A Flow controller may create the association when it takes
   enforcement action against an endpoint. A PDP may create the
   association when it instructs a PEP to take enforcement action
   against an endpoint.
 

Specified by:
createEnforcementReport in interface StandardIfmapMetadataFactory
Parameters:
enforcementAction - the enforcement action that should be taken
otherTypeDefinition - this must not be null if action is EnforcementAction.block
enforcementReason - the reason of the enforcement
Returns:
a Document that represents the metadata

createEvent

public Document createEvent(String name,
                            String discoveredTime,
                            String discovererId,
                            Integer magnitude,
                            Integer confidence,
                            Significance significance,
                            EventType type,
                            String otherTypeDefinition,
                            String information,
                            String vulnerabilityUri)
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing event metadata.
   event metadata refers to activity of interest detected on
   the network. Examples include network traffic that matches
   the profile of a virus attack, excessive network traffic
   originating from a particular endpoint, and the use of a
   specific protocol such as an Instant Messaging protocol.
 

Specified by:
createEvent in interface StandardIfmapMetadataFactory
Parameters:
name - the name of the event
discoveredTime - the time it was discovered
discovererId - the entity that discovered the event
magnitude - must be between 0 and 100
confidence - must be between 0 and 100
significance - the significance of the event
type - the type of the event
otherTypeDefinition - must not be null if type is EventType.other
information - a human readable String containgin further information
vulnerabilityUri - must not be null if event is of type EventType.cve
Returns:
a Document that represents the metadata

createLayer2Information

public Document createLayer2Information(Integer vlanNum,
                                        String vlanName,
                                        Integer port,
                                        String administrativeDomain)
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing layer2-information metadata.
   layer2-information is attached to a link between an
   access-request and the device identifier of the PEP through
   which access is occurring. layer2-information includes vlan,
   which specifies the VLAN assigned to the access request;
   port, which specifies the port on the layer 2 PEP that the
   access-request originates from; and an optional
   administrative-domain, which may be used to distinguish between
   two instances of the same VLAN number in different parts of a network.
 

Specified by:
createLayer2Information in interface StandardIfmapMetadataFactory
Parameters:
vlanNum - the ID of the VLAN
vlanName - the name of the VLAN
port - the port number
administrativeDomain - the administrative domain (may be null)
Returns:
a Document that represents the metadata

createLocation

public Document createLocation(List<LocationInformation> locationInformation,
                               String discoveredTime,
                               String discovererId)
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing location metadata.
   The location metadata element represents a named region
   of space – usually a region with security import. The
   region may be contiguous or discontiguous and may have any
   shape and boundaries as defined by an organization.
 

Specified by:
createLocation in interface StandardIfmapMetadataFactory
Parameters:
locationInformation - list of all location information elements
discoveredTime - the time the location information was discovered
discovererId - the entity that discovered the location information
Returns:
a Document that represents the metadata

createRequestForInvestigation

public Document createRequestForInvestigation(String qualifier)
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing request-for-investigation metadata.
   request-for-investigation metadata indicates that specified
   device, which may be a PDP or other MAP Client, wants Sensors
   to publish device-characteristic metadata about the specified
   MAC or IP address.
 

Specified by:
createRequestForInvestigation in interface StandardIfmapMetadataFactory
Parameters:
qualifier - indicate what type of investigation should be done
Returns:
a Document that represents the metadata

createWlanInformation

public Document createWlanInformation(String ssid,
                                      List<WlanSecurityType> ssidUnicastSecurity,
                                      WlanSecurityType ssidGroupSecurity,
                                      List<WlanSecurityType> ssidManagementSecurity)
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing wlan-information metadata.
   wlan-information is attached to a link to associate
   a specific access-request identifier with a specific
   device identifier representing the PEP through which
   access is occurring.
 

Specified by:
createWlanInformation in interface StandardIfmapMetadataFactory
ssidUnicastSecurity - the unicast security
ssidGroupSecurity - the group security
ssidManagementSecurity - the management security
Returns:
a Document that represents the metadata

createUnexpectedBehavior

public Document createUnexpectedBehavior(String discoveredTime,
                                         String discovererId,
                                         Integer magnitude,
                                         Integer confidence,
                                         Significance significance,
                                         String type)
Description copied from interface: StandardIfmapMetadataFactory
Create a Document representing unexpected-behavior metadata.
   Unexpected-behavior metadata indicates that an endpoint
   is behaving in an unauthorized or unexpected manner (e.g.
   an endpoint previously profiled as a printer that starts
   sending non-print-related traffic).
 

Specified by:
createUnexpectedBehavior in interface StandardIfmapMetadataFactory
Parameters:
discoveredTime - the time it was discovered
discovererId - the entity that discovered it
magnitude - element indicates how severe the effects of the activity are. Ranges from 0 to 100.
confidence - indicates how confident the MAP Client that published the metadata is that it accurately describes the activity of interest. Ranges from 0 to 100.
significance - indicates how important the unexpected behavior is
type - machine consumable String indicating the nature of the unexpected behavior
Returns:
a Document that represents the metadata


Copyright © 2012 Trust@FHH. All Rights Reserved.