CIA Compliance Manager API Documentation - v1.1.6
    Preparing search index...

    Class CIAContentService

    Main service to provide CIA content and utilities throughout the application

    This service acts as a central hub for accessing security-related information across the CIA triad, providing consistent data and calculations for business impact analysis, technical implementations, and compliance requirements. 🔒

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    name

    Methods

    calculateBusinessImpactLevel calculateRoi getAllROIEstimates getBusinessImpact getBusinessImpactContent getBusinessImpactDescription getCategoryIcon getCIAOptions getComplianceDescription getComplianceStatus getCompliantFrameworks getComponentContent getComponentDetails getComponentImplementationDetails getComponentMetrics getDefaultErrorRate getDefaultPrivacyImpact getDefaultSLAMetrics getDefaultValidationLevel getDetailedDescription getFrameworkDescription getFrameworkRequiredLevel getImpactMetrics getImplementationConsiderations getImplementationTime getInformationSensitivity getKeyValuePoints getProtectionLevel getRecommendations getRecommendedImplementationPlan getRequiredExpertise getRiskBadgeVariant getRiskLevelFromSecurityLevel getROIEstimate getROIEstimates getSecurityIcon getSecurityLevelDescription getSecurityMetrics getSecurityResources getSummaryContent getTechnicalDescription getTechnicalImplementation getTotalImplementationTime getValuePoints handleError initialize validate

    Constructors

    Properties

    name: string = 'BaseService'

    Service name for identification

    Methods

    • Calculate business impact level based on security levels

      Parameters

      • availabilityLevel: SecurityLevel

        Availability security level

      • integrityLevel: SecurityLevel = availabilityLevel

        Integrity security level (optional, defaults to availabilityLevel)

      • confidentialityLevel: SecurityLevel = availabilityLevel

        Confidentiality security level (optional, defaults to availabilityLevel)

      Returns string

      Business impact level description

    • Get options data for a CIA component

      Retrieves all security level options (None through Very High) for a specific CIA triad component, including descriptions, technical details, costs, and recommendations.

      Parameters

      • component: CIAComponentType

        CIA component type ('confidentiality', 'integrity', or 'availability')

      Returns Record<SecurityLevel, CIADetails>

      Record mapping each SecurityLevel to its CIADetails

      const service = new CIAContentService(dataProvider);
      const options = service.getCIAOptions('confidentiality');

      // Access specific level
      console.log(options['High'].description);
      console.log(options['High'].capex); // CAPEX percentage

      // Iterate through all levels
      Object.entries(options).forEach(([level, details]) => {
        console.log(`${level}: ${details.description}`);
      });

    • Get component content details for a specific component and security level

      Parameters

      • component: CIAComponentType

        CIA component type (availability, integrity, confidentiality)

      • level: string

        Security level

      Returns {
          businessImpact: string;
          description: string;
          recommendations: string[];
          technical: string;
      }

      Component content details

    • Get details for a specific component and security level

      Retrieves comprehensive details for a specific CIA component at a given security level, including description, technical requirements, business impact, cost estimates (CAPEX/OPEX), and implementation recommendations.

      Parameters

      • component: CIAComponentType

        CIA component type ('confidentiality', 'integrity', or 'availability')

      • level: SecurityLevel

        Security level ('None', 'Low', 'Moderate', 'High', 'Very High')

      Returns CIADetails | undefined

      CIADetails object with all information, or undefined if invalid component

      const service = new CIAContentService(dataProvider);

      // Get High confidentiality details
      const details = service.getComponentDetails('confidentiality', 'High');

      if (details) {
        console.log('Description:', details.description);
        console.log('Technical:', details.technical);
        console.log('Business Impact:', details.businessImpact);
        console.log('CAPEX:', details.capex, '%');
        console.log('OPEX:', details.opex, '%');
        console.log('Colors:', details.bg, details.text);
        
        // Access recommendations
        details.recommendations?.forEach(rec => {
          console.log('- ', rec);
        });
      }

    • Get default SLA metrics based on security level

      Parameters

      Returns { mttr: string; rpo: string; rto: string; sla: string; uptime: string }

      SLA metrics for availability

    • Get risk badge variant

      Parameters

      • riskLevel: string

      Returns "success" | "info" | "warning" | "error" | "neutral"

    • Get ROI (Return on Investment) estimate for a security level

      Calculates the expected return on investment for implementing security controls at a specific level. Higher security levels typically provide better ROI through risk mitigation and incident prevention.

      Parameters

      Returns ROIEstimate

      ROI estimate with value, return rate, and description

      const service = new CIAContentService(dataProvider);

      // Get ROI for High security level
      const roi = service.getROIEstimate('High');
      console.log('ROI Value:', roi.value);           // e.g., "250%"
      console.log('Return Rate:', roi.returnRate);    // e.g., "150%"
      console.log('Description:', roi.description);

      // Compare ROI across levels
      ['Low', 'Moderate', 'High'].forEach(level => {
        const levelRoi = service.getROIEstimate(level as SecurityLevel);
        console.log(`${level}: ${levelRoi.value}`);
      });

    • Initialize the service This is a placeholder for any async initialization that might be needed

      Returns Promise<void>

    • Validate input parameters (to be overridden by subclasses)

      Parameters

      • input: unknown

        Input to validate

      Returns boolean

      True if valid, false otherwise

    Settings

    Member Visibility

    On This Page

    Business Perspective
    Constructors
    Properties
    Methods
    calculateBusinessImpactLevelcalculateRoigetAllROIEstimatesgetBusinessImpactgetBusinessImpactContentgetBusinessImpactDescriptiongetCategoryIcongetCIAOptionsgetComplianceDescriptiongetComplianceStatusgetCompliantFrameworksgetComponentContentgetComponentDetailsgetComponentImplementationDetailsgetComponentMetricsgetDefaultErrorRategetDefaultPrivacyImpactgetDefaultSLAMetricsgetDefaultValidationLevelgetDetailedDescriptiongetFrameworkDescriptiongetFrameworkRequiredLevelgetImpactMetricsgetImplementationConsiderationsgetImplementationTimegetInformationSensitivitygetKeyValuePointsgetProtectionLevelgetRecommendationsgetRecommendedImplementationPlangetRequiredExpertisegetRiskBadgeVariantgetRiskLevelFromSecurityLevelgetROIEstimategetROIEstimatesgetSecurityIcongetSecurityLevelDescriptiongetSecurityMetricsgetSecurityResourcesgetSummaryContentgetTechnicalDescriptiongetTechnicalImplementationgetTotalImplementationTimegetValuePointshandleErrorinitializevalidate