Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * #%L
   * =====================================================
   *   _____                _     ____  _   _       _   _
   *  |_   _|_ __ _   _ ___| |_  / __ \| | | | ___ | | | |
   *    | | | '__| | | / __| __|/ / _` | |_| |/ __|| |_| |
   *    | | | |  | |_| \__ \ |_| | (_| |  _  |\__ \|  _  |
   *    |_| |_|   \__,_|___/\__|\ \__,_|_| |_||___/|_| |_|
   *                             \____/
  * 
  * =====================================================
  * 
  * Hochschule Hannover
  * (University of Applied Sciences and Arts, Hannover)
  * Faculty IV, Dept. of Computer Science
  * Ricklinger Stadtweg 118, 30459 Hannover, Germany
  * 
  * Email: trust@f4-i.fh-hannover.de
  * Website: http://trust.f4.hs-hannover.de/
  * 
  * This file is part of ifmapj, version 2.1.0, implemented by the Trust@HsH
  * research group at the Hochschule Hannover.
  * %%
  * Copyright (C) 2010 - 2014 Trust@HsH
  * %%
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  * 
  *      http://www.apache.org/licenses/LICENSE-2.0
  * 
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  * #L%
  */
 package de.hshannover.f4.trust.ifmapj.metadata;
 
 import java.util.List;
 
Inteface to create some of the standard metadata specified by IF-MAP 2.0.

Author(s):
aw
ib
 
 public interface StandardIfmapMetadataFactory {

Create a org.w3c.dom.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
 

Parameters:
startTime the start-time value or null
endTime the end-time value or null
dhcpServer the dhcp-server value or null
Returns:
a org.w3c.dom.Document that represents the metadata
 
 	Document createIpMac(String startTimeString endTimeString dhcpServer);

Create a org.w3c.dom.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
 

Returns:
a org.w3c.dom.Document that represents the metadata
 
Create a org.w3c.dom.Document representing access-request-mac metadata.
  access-request-mac is link metadata that
  associates an access-request identifier with
  a mac-address identifier
 

Returns:
a org.w3c.dom.Document that represents the metadata
 
Create a org.w3c.dom.Document representing access-request-device metadata.
  access-request-device is link metadata that
  associates an access-request identifier with
  a device identifier
 

Returns:
a org.w3c.dom.Document that represents the metadata
Create a org.w3c.dom.Document representing access-request-ip metadata.
  access-request-ip is link metadata that
  associates an access-request identifier with
  an ip-address identifier
 

Returns:
a org.w3c.dom.Document that represents the metadata
Create a org.w3c.dom.Document representing authenticated-as metadata.
  authenticated-as is link metadata that
  associates an access-request identifier with
  an identity identifier
 

Returns:
a org.w3c.dom.Document that represents the metadata
Create a org.w3c.dom.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
 

Returns:
a org.w3c.dom.Document that represents the metadata
Create a org.w3c.dom.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
 

Returns:
a org.w3c.dom.Document that represents the metadata
Create a org.w3c.dom.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
 

Returns:
a org.w3c.dom.Document that represents the metadata
Create a org.w3c.dom.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
 

Parameters:
name the name of the role
administrativeDomain the administrative-domain or null
Returns:
a org.w3c.dom.Document that represents the metadata
	Document createRole(String nameString administrativeDomain);

Create a org.w3c.dom.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
 

Parameters:
name
Returns:
a org.w3c.dom.Document that represents the metadata
Create a org.w3c.dom.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
 

Parameters:
name the name of the attribute
Returns:
a org.w3c.dom.Document that represents the metadata
Create a org.w3c.dom.Document representing capability metadata.
  capability metadata refers to a collection of privileges
  assigned to an endpoint as a result of an access request.
 

Parameters:
name the name of the capability
administrativeDomain the administrative-domain or null
Returns:
a org.w3c.dom.Document that represents the metadata
	Document createCapability(String nameString administrativeDomain);

Create a org.w3c.dom.Document representing capability metadata.
  capability metadata refers to a collection of privileges
  assigned to an endpoint as a result of an access request.
 

Parameters:
name the name of the capability
Returns:
a org.w3c.dom.Document that represents the metadata
Create a org.w3c.dom.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.
 

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 org.w3c.dom.Document that represents the metadata
			String modelString osString osVersionString deviceType,
			String discoveredTimeString discovererIdString discoveryMethod);

Create a org.w3c.dom.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.
 

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 org.w3c.dom.Document that represents the metadata
			String otherTypeDefinitionString enforcementReason);

Create a org.w3c.dom.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.
 

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 java.lang.String containgin further information
vulnerabilityUri must not be null if event is of type EventType.cve
Returns:
a org.w3c.dom.Document that represents the metadata
	Document createEvent(String nameString discoveredTimeString discovererId,
			Integer magnitudeInteger confidenceSignificance significance,
			EventType typeString otherTypeDefinitionString information,
			String vulnerabilityUri);

Create a org.w3c.dom.Document representing custom metadata.
   any single metadata element can be added with one attribute
 

Parameters:
elementName element name
qualifiedName namespace qualifier
uri namespace uri
cardinality ifmap cardinality
Returns:
	Document create(String elementNameString qualifiedNameString uri,
			Cardinality cardinality);

Create a org.w3c.dom.Document representing custom metadata.
   any single metadata element can be added with one attribute
 

Parameters:
elementName element name
qualifiedName namespace qualifier
uri namespace uri
cardinality ifmap cardinality
attrName attribute name
attrValue attribute value
Returns:
	Document create(String elementNameString qualifiedNameString uri,
			Cardinality cardinalityString attrNameString attrValue);

Create a org.w3c.dom.Document representing custom metadata.
   any single metadata element can be added with attributes
 

Parameters:
elementName element name
qualifiedName namespace qualifier
uri namespace uri
cardinality ifmap cardinality
attributes hashmap with attributes
Returns:
	Document create(String elementNameString qualifiedNameString uri,
			Cardinality cardinalityHashMap<StringStringattributes);

Create a org.w3c.dom.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.
 

Parameters:
vlan the ID of the VLAN
vlanName the name of the VLAN
port the port number
administrativeDomain the administrative domain (may be null)
Returns:
a org.w3c.dom.Document that represents the metadata
			Integer portString administrativeDomain);

Create a org.w3c.dom.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.
 

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 org.w3c.dom.Document that represents the metadata
			String discoveredTimeString discovererId);

Create a org.w3c.dom.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.
 

Parameters:
qualifier indicate what type of investigation should be done
Returns:
a org.w3c.dom.Document that represents the metadata
Create a org.w3c.dom.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.
 

Parameters:
ssidUnicastSecurity the unicast security
ssidGroupSecurity the group security
ssidManagementSecurity the management security
Returns:
a org.w3c.dom.Document that represents the metadata
			List<WlanSecurityTypessidUnicastSecurity,
			WlanSecurityType ssidGroupSecurity,
			List<WlanSecurityTypessidManagementSecurity);

Create a org.w3c.dom.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).
 

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 java.lang.String indicating the nature of the unexpected behavior
Returns:
a org.w3c.dom.Document that represents the metadata
	Document createUnexpectedBehavior(String discoveredTimeString discovererId,
			Integer magnitudeInteger confidenceSignificance significance,
			String type);

Create a org.w3c.dom.Document representing client time metadata.
   Client time metadata is used for clock skew detection. The
   clients timestamp can be compared to the servers timestamp
   in order to detect and compensate clock skew between both systems.
 

Parameters:
time the clients ISO-8601 UTC timestamp
Returns:
a org.w3c.dom.Document that represents the metadata
New to GrepCode? Check out our FAQ X