CertificateService (plusworkflow-api 4.0.42 API)

```
public interface CertificateService
```
Zarządza certyfikatami w systemie oraz wspomaga operacje na nich.

Author:

Grzegorz Konowalczyk 2020-09-21

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`exportCertificatesToKeyStore(Map<String,Certificate> certs, OutputStream out, char[] password)` Eksportuje certyfikaty jako KeyStore z aliasami z klucza mapy oraz ich certyfikatami.
`void`	`exportCertificateToStream(Certificate cert, OutputStream out)` Eksportuje do strumienia certyfikat w formacie .pem.
`Certificate`	`getCertificate(String alias)` Zwraca certyfikat pod wybranym aliasem z systemowego KeyStore, który był wgrywany z poziomu systemu.
`Map<String,Certificate>`	`getCertificates()` Zwraca certyfikaty z systemowego KeyStore, które były wgrywane z poziomu systemu.
`Certificate`	`getSystemCertificate(String alias)` Zwraca systemowy certyfikat pod wybranym aliasem z systemowego KeyStore.
`Map<String,Certificate>`	`getSystemCertificates()` Zwraca systemowe certyfikaty z systemowego KeyStore.
`void`	`importCertificate(String alias, Certificate cert, boolean shouldOverride)` Importuje certyfikat do systemowego KeyStore.
`void`	`importCertificateFromStream(String alias, InputStream in, boolean shouldOverride)` Importuje certyfikat ze strumienia w formacie .pem do systemowego KeyStore.
`void`	`importCertificates(Map<String,Certificate> certs, boolean shouldOverride)` Importuje certyfikaty do systemowego KeyStore.
`void`	`importCertificatesFromKeyStore(InputStream in, char[] password, boolean shouldOverride)` Importuje certyfikaty ze strumienia znajdujace się w KeyStore do systemowego KeyStore.
`boolean`	`isAliasValid(String alias)` Sprawdza, czy dany alias jest prawidłowego formatu.
`boolean`	`isCustomAliasValid(String alias)` Sprawdza, czy dany alias jest prawidłowego formatu dla niestandardowego certyfikatu.
`boolean`	`isRestartRequired()` Sprawdza, czy ostatnio były dokonywane zmiany w certyfikatach wymagające restartu systemu.
`boolean`	`isSystemAlias(String alias)` Sprawdza, czy dany alias jest systemowy.
`Certificate`	`readCertificateFromStream(InputStream in)` Odczytuje certyfikat w formacie .pem ze wskazanego strumienia.
`Map<String,Certificate>`	`readCertificatesFromKeyStore(InputStream in, char[] password)` Odczytuje certyfikaty ze wskazanego strumienia KeyStore.
`void`	`removeCertificate(String alias)` Usuwa certyfikat z podanym aliasem z systemowego KeyStore.
`void`	`renameCertificate(String alias, String newAlias)` Zmienia nazwę aliasu dla certyfikatu.
`String`	`trimInvalidAliasChars(String text)` Usuwa z podanego tekstu wszystkie znaki niedozwolone w aliasie.
`void`	`validateAlias(String alias)` Sprawdza, czy dany alias jest prawidłowego formatu.
`void`	`validateCustomAlias(String alias)` Sprawdza, czy dany alias jest prawidłowego formatu dla niestandardowego certyfikatu.
`void`	`validateSystemAlias(String alias)` Sprawdza, czy dany alias reprezentuje systemowy certyfikat.

- Method Detail
  - isRestartRequired
```
boolean isRestartRequired()
```
    Sprawdza, czy ostatnio były dokonywane zmiany w certyfikatach wymagające restartu systemu.
    
    Returns:
    
    czy ostatnio dokonywane zmiany wymagają restartu systemu.
  - importCertificatesFromKeyStore
```
void importCertificatesFromKeyStore(InputStream in,
                                    char[] password,
                                    boolean shouldOverride)
```
    Importuje certyfikaty ze strumienia znajdujace się w KeyStore do systemowego KeyStore.
    
    Parameters:
    
    in - strumień, z którego ma zostać wczytany KeyStore.
    
    password - hasło do KeyStore w postaci tablicy char'ów.
    
    shouldOverride - czy powinno nastąpić nadpisanie aliasu w systemowym KeyStore, gdy już istnieje.
  - importCertificateFromStream
```
void importCertificateFromStream(String alias,
                                 InputStream in,
                                 boolean shouldOverride)
```
    Importuje certyfikat ze strumienia w formacie .pem do systemowego KeyStore.
    
    Parameters:
    
    alias - alias, pod którym ma zostać wczytany certyfikat do systemowego KeyStore.
    
    in - strumień, z którego ma zostać wczytany certyfikat.
    
    shouldOverride - czy powinno nastąpić nadpisanie aliasu w systemowym KeyStore, gdy już istnieje.
  - importCertificates
```
void importCertificates(Map<String,Certificate> certs,
                        boolean shouldOverride)
```
    Importuje certyfikaty do systemowego KeyStore.
    
    Parameters:
    
    certs - mapa aliasów z przypisanymi do nich certyfikatami.
    
    shouldOverride - czy powinno nastąpić nadpisanie aliasu w systemowym KeyStore, gdy już istnieje.
  - importCertificate
```
void importCertificate(String alias,
                       Certificate cert,
                       boolean shouldOverride)
```
    Importuje certyfikat do systemowego KeyStore.
    
    Parameters:
    
    alias - alias, pod którym ma zostać wczytany certyfikat do systemowego KeyStore.
    
    cert - certyfikat wgrywany do systemowego KeyStore
    
    shouldOverride - czy powinno nastąpić nadpisanie aliasu w systemowym KeyStore, gdy już istnieje.
  - readCertificatesFromKeyStore
```
Map<String,Certificate> readCertificatesFromKeyStore(InputStream in,
                                                     char[] password)
```
    Odczytuje certyfikaty ze wskazanego strumienia KeyStore.
    
    Parameters:
    
    in - strumień KeyStore, z którego mają zostać wczytane certyfikaty.
    
    password - tablica char'ów z hasłem do KeyStore.
    
    Returns:
    
    mapa aliasów z przypisanymi im certyfikatami odczytanych ze strumienia.
  - readCertificateFromStream
```
Certificate readCertificateFromStream(InputStream in)
```
    Odczytuje certyfikat w formacie .pem ze wskazanego strumienia.
    
    Parameters:
    
    in - strumień, z którego ma zostać wczytany certyfikat.
    
    Returns:
    
    obiekt certyfikatu odczytany ze strumienia.
  - exportCertificatesToKeyStore
```
void exportCertificatesToKeyStore(Map<String,Certificate> certs,
                                  OutputStream out,
                                  char[] password)
```
    Eksportuje certyfikaty jako KeyStore z aliasami z klucza mapy oraz ich certyfikatami.
    
    Parameters:
    
    certs - mapa aliasów z przypisanymi do nich certyfikatami.
    
    out - strumień KeyStore, do którego ma zostać zapisany KeyStore z certyfikatami.
    
    password - tablica char'ów z hasłem do KeyStore.
  - exportCertificateToStream
```
void exportCertificateToStream(Certificate cert,
                               OutputStream out)
```
    Eksportuje do strumienia certyfikat w formacie .pem.
    
    Parameters:
    
    cert - eksportowany certyfikat.
    
    out - strumień, do którego ma zostać wczytany certyfikat.
  - getCertificates
```
Map<String,Certificate> getCertificates()
```
    Zwraca certyfikaty z systemowego KeyStore, które były wgrywane z poziomu systemu.
    
    Returns:
    
    mapę zawierającą aliasy z przypisanymi im certyfikatami, które były wgrywane z poziomu systemu.
  - getSystemCertificates
```
Map<String,Certificate> getSystemCertificates()
```
    Zwraca systemowe certyfikaty z systemowego KeyStore.
    
    Returns:
    
    mapę zawierającą aliasy z przypisanymi im certyfikatami.
  - getCertificate
```
Certificate getCertificate(String alias)
```
    Zwraca certyfikat pod wybranym aliasem z systemowego KeyStore, który był wgrywany z poziomu systemu.
    
    Parameters:
    
    alias - alias certyfikatu z systemowego KeyStore.
    
    Returns:
    
    obiekt certyfikatu o podanym aliasie lub null, jeżeli taki nie istnieje.
  - getSystemCertificate
```
Certificate getSystemCertificate(String alias)
```
    Zwraca systemowy certyfikat pod wybranym aliasem z systemowego KeyStore.
    
    Parameters:
    
    alias - alias systemowego certyfikatu z systemowego KeyStore.
    
    Returns:
    
    obiekt systemowego certyfikatu o podanym aliasie lub null, jeżeli taki nie istnieje.
  - renameCertificate
```
void renameCertificate(String alias,
                       String newAlias)
```
    Zmienia nazwę aliasu dla certyfikatu.
    
    Parameters:
    
    alias - obecny alias certyfikatu.
    
    newAlias - nowy alias dla certyfikatu.
  - removeCertificate
```
void removeCertificate(String alias)
```
    Usuwa certyfikat z podanym aliasem z systemowego KeyStore. Tylko certyfikaty wgrane z poziomu systemu mogą być usunięte.
    
    Parameters:
    
    alias - alias usuwanego certyfikatu.
  - isAliasValid
```
boolean isAliasValid(String alias)
```
    Sprawdza, czy dany alias jest prawidłowego formatu.
    
    Parameters:
    
    alias - alias do sprawdzenia.
    
    Returns:
    
    prawdę jeżeli alias jest prawidłowego formatu, w przeciwnym razie fałsz.
  - isCustomAliasValid
```
boolean isCustomAliasValid(String alias)
```
    Sprawdza, czy dany alias jest prawidłowego formatu dla niestandardowego certyfikatu.
    
    Parameters:
    
    alias - alias do sprawdzenia
    
    Returns:
    
    prawdę jeżeli alias jest prawidłowego formatu dla niestandardowego certyfikatu, w przeciwnym razie fałsz.
  - isSystemAlias
```
boolean isSystemAlias(String alias)
```
    Sprawdza, czy dany alias jest systemowy.
    
    Parameters:
    
    alias - do sprawdzenia.
    
    Returns:
    
    prawdę jeżeli alias jest prawidłowego formatu dla systemowego certyfikatu, w przeciwnym razie fałsz.
  - validateAlias
```
void validateAlias(String alias)
```
    Sprawdza, czy dany alias jest prawidłowego formatu. Rzuca wyjątek, gdy takowy nie jest akceptowalny.
    
    Parameters:
    
    alias - alias do sprawdzenia
  - validateCustomAlias
```
void validateCustomAlias(String alias)
```
    Sprawdza, czy dany alias jest prawidłowego formatu dla niestandardowego certyfikatu. Rzuca wyjątek, gdy takowy nie jest akceptowalny.
    
    Parameters:
    
    alias - alias do sprawdzenia
  - validateSystemAlias
```
void validateSystemAlias(String alias)
```
    Sprawdza, czy dany alias reprezentuje systemowy certyfikat. Rzuca wyjątek, gdy takowym nie jest.
    
    Parameters:
    
    alias - alias do sprawdzenia
  - trimInvalidAliasChars
```
String trimInvalidAliasChars(String text)
```
    Usuwa z podanego tekstu wszystkie znaki niedozwolone w aliasie.
    
    Parameters:
    
    text - tekst to przefiltrowania pod względem niedozwolonych znaków dla aliasu.
    
    Returns:
    
    alias bez niedozwolonych znaków.

Interface CertificateService

Method Summary

Method Detail

isRestartRequired

importCertificatesFromKeyStore

importCertificateFromStream

importCertificates

importCertificate

readCertificatesFromKeyStore

readCertificateFromStream

exportCertificatesToKeyStore

exportCertificateToStream

getCertificates

getSystemCertificates

getCertificate

getSystemCertificate

renameCertificate

removeCertificate

isAliasValid

isCustomAliasValid

isSystemAlias

validateAlias

validateCustomAlias

validateSystemAlias

trimInvalidAliasChars