pl.infinite.edinetws

Class MessageInput

java.lang.Object

pl.infinite.edinetws.MessageInput

public class MessageInput
extends java.lang.Object

Usługa umożliwia wysyłanie dowolnych komunikatów do systemu EDInet na prawach podanego użytkownika. Format komunikatu wyznaczony jest przez umownie przyjety identyfikator. Jeżeli komunikat nie zawiera wystarczających do przetworzenia go danych należy dane te należy podać w tablicy parametrów, kolejność wystapienia parametrów jest istotna i ściśle powiązana z formatem komunikatu. W odpowiedzi na wysłany komunikat zwracane są podstawowe informacje diagnostyczne opisane przez klasę PutMessageResponse: status i nadany komunikatowi identyfikator.

The service allows you to send any messages to the system EDInet on the rights of the named user. The message format is determined by the identifier. If the message does not contain sufficient information to process the data it shall be provided in an array of parameters, the order of occurrence of the parameters is important and closely related to the format of the message. In response to a message methods return basic diagnostic information described by the class PutMessageResponse.

Constructor Summary

Constructors

Constructor and Description
MessageInput()

Method Summary

Modifier and Type	Method and Description
static PutMessageResponse	putMessage(java.lang.String userName, java.lang.String password, java.lang.String msgFmtId, javax.activation.DataHandler msgHandler) Metoda służy do wysyłania ogólnych komunikatów o określonym formacie.
static PutMessageResponse	putMessageSystem(java.lang.String userName, java.lang.String password, java.lang.String msgFmtId, javax.activation.DataHandler msgHandler, java.lang.String system) Metoda służy do wysyłania ogólnych komunikatów o określonym formacie.
static PutMessageResponse	putMessageSystemWithControl(java.lang.String userName, java.lang.String password, java.lang.String msgFmtId, javax.activation.DataHandler msgHandler, java.lang.String[] params, java.lang.String checksumAlg, java.lang.String checksum, java.lang.String system) Metoda służy do wysyłania ogólnych komunikatów o określonym formacie.
static PutMessageResponse	putMessageSystemWithParams(java.lang.String userName, java.lang.String password, java.lang.String msgFmtId, javax.activation.DataHandler msgHandler, java.lang.String[] params, java.lang.String system) Deprecated.
static PutMessageResponse	putMessageWithControl(java.lang.String userName, java.lang.String password, java.lang.String msgFmtId, javax.activation.DataHandler msgHandler, java.lang.String[] params, java.lang.String checksumAlg, java.lang.String checksum) Metoda służy do wysyłania ogólnych komunikatów o określonym formacie.
static PutMessageResponse	putMessageWithParams(java.lang.String userName, java.lang.String password, java.lang.String msgFmtId, javax.activation.DataHandler msgHandler, java.lang.String[] params) Deprecated.
static PutMessageResponse	putSignedMessage(java.lang.String userName, java.lang.String password, java.lang.String msgFmtId, byte[] msgBytes, java.lang.String msgContentType, java.lang.String signature, java.lang.String cert) Metoda służy do wysyłania podpisanych komunikatów o określonym formacie.
static PutMessageResponse	putSignedMessageSystem(java.lang.String userName, java.lang.String password, java.lang.String msgFmtId, javax.activation.DataHandler msgHandler, java.lang.String[] params, java.lang.String signature, java.lang.String cert, java.lang.String system) Metoda służy do wysyłania ogólnych komunikatów o określonym formacie.
static PutMessageResponse	putSignedMessageWithParams(java.lang.String userName, java.lang.String password, java.lang.String msgFmtId, javax.activation.DataHandler msgHandler, java.lang.String[] params, java.lang.String signature, java.lang.String cert) Metoda służy do wysyłania ogólnych komunikatów o określonym formacie.
static PutMessageResponse	setMessageLocation(java.lang.String userName, java.lang.String password, java.lang.String msgId, int locationCode) Przeciazenie metody SetMessageLocation, bez koniecznosci podawania systemu SetMessageLocation method is overloaded, no necessity to enter the system.
static PutMessageResponse	setMessageLocationSystem(java.lang.String userName, java.lang.String password, java.lang.String msgId, int locationCode, java.lang.String system) Usługa umożliwia ustawianie statusu (lokalizacji) dokumentów pobranych z systemu EDInet na prawach podanego użytkownika.
static PutMessageResponse	setMessageLocationWithReceiverDesc(java.lang.String userName, java.lang.String password, java.lang.String msgId, int locationCode, java.lang.String receiverCode, java.lang.String receiverDescription) Przeciazenie metody SetMessageLocation, bez koniecznosci podawania systemu, z możliwością przesłania własnego kodu operacji i jej opisu. class="en">SetMessageLocation method is overloaded, no necessity to enter the system but with the possibility of sending own operation code and its description.
static PutMessageResponse	setSentMessageLocationWithReceiverDesc(java.lang.String userName, java.lang.String password, java.lang.String msgId, int locationCode, java.lang.String receiverDescription) Usługa umożliwia ustawianie statusu (lokalizacji) dokumentów wysłanych do systemu EDInet na prawach podanego użytkownika.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageInput

public MessageInput()

Method Detail

putMessageWithControl

public static PutMessageResponse putMessageWithControl(java.lang.String userName,
                                                       java.lang.String password,
                                                       java.lang.String msgFmtId,
                                                       javax.activation.DataHandler msgHandler,
                                                       java.lang.String[] params,
                                                       java.lang.String checksumAlg,
                                                       java.lang.String checksum)

Metoda służy do wysyłania ogólnych komunikatów o określonym formacie. Ta metoda korzysta z sum kontrolnych do sprawdzania integralności komunikatu.

The method used to send general messages of a certain format. This method uses checksums to verify the integrity of the message.

Parameters:

userName -

Nazwa użytkownika systemu EDInet (wielkość znaków nie ma znaczenia), na którego prawach będzie przetworzony komunikat

User Name EDInet system (case does not matter), whose rights will be processed the message

password -

Hasło użytkownika (istotna wielkość znaków)

User password (case-sensitive)

msgFmtId -

Identyfikator formatu komunikatu

message format ID

msgHandler -

Uchwyt danych komunikatu

Handler to the message data

params -

Tablica dodatkowych parametrów komunikatu, uwaga istotna kolejność!

An array of additional parameters of message, note the importance of order !

checksumAlg -

Algorytm, który został uzyty do wyznaczenia sumy kontrolnej komunikatu (CRC32, MD5, SHA1)

The algorithm that was used to determine the message checksum (CRC32, MD5, SHA1)

checksum -

Znakowa reprezentacja sumy kontrolnej komunikatu, CRC32 łancuch zawierający liczbę całkowita, MD5 i SHA1 łańcuch zawierający szestnastowy zapis dużej liczby całkowitej

Char data type of check sum of the message, CRC32 chain which contains integer number, MD5 and SHA1 chain which contains hexadecimal notation of a large integer.

Returns:

@see PutMessageResponse

putMessageWithParams

@Deprecated
public static PutMessageResponse putMessageWithParams(java.lang.String userName,
                                                                  java.lang.String password,
                                                                  java.lang.String msgFmtId,
                                                                  javax.activation.DataHandler msgHandler,
                                                                  java.lang.String[] params)

Deprecated.

Metoda służy do wysyłania ogólnych komunikatów o określonym formacie. Ta metoda korzysta z sum kontrolnych do sprawdzania integralności komunikatu.

The method used to send general messages of a certain format. This method uses checksums to verify the integrity of the message.

Parameters:

userName -

Nazwa użytkownika systemu EDInet (wielkość znaków nie ma znaczenia), na którego prawach będzie przetworzony komunikat

User Name EDInet system (case does not matter), whose rights will be processed the message

password -

Hasło użytkownika (istotna wielkość znaków)

User password (case-sensitive)

msgFmtId -

Identyfikator formatu komunikatu

message format ID

msgHandler -

Uchwyt danych komunikatu

Handler to the message data

params -

Tablica parametrów koniecznych do wstawienia komunikatu

Array of params

Returns:

@see PutMessageResponse

putMessage

public static PutMessageResponse putMessage(java.lang.String userName,
                                            java.lang.String password,
                                            java.lang.String msgFmtId,
                                            javax.activation.DataHandler msgHandler)

Metoda służy do wysyłania ogólnych komunikatów o określonym formacie.

The method used to send general messages of a certain format.

Parameters:

userName -

Nazwa użytkownika systemu EDInet (wielkość znaków nie ma znaczenia), na którego prawach będzie przetworzony komunikat

User Name EDInet system (case does not matter), whose rights will be processed the message

password -

Hasło użytkownika (istotna wielkość znaków)

User password (case-sensitive)

msgFmtId -

Identyfikator formatu komunikatu

message format ID

msgHandler -

Uchwyt danych komunikatu

Handler to the message data

Returns:

@see PutMessageResponse

putMessageSystemWithControl

public static PutMessageResponse putMessageSystemWithControl(java.lang.String userName,
                                                             java.lang.String password,
                                                             java.lang.String msgFmtId,
                                                             javax.activation.DataHandler msgHandler,
                                                             java.lang.String[] params,
                                                             java.lang.String checksumAlg,
                                                             java.lang.String checksum,
                                                             java.lang.String system)

Metoda służy do wysyłania ogólnych komunikatów o określonym formacie. Ta metoda korzysta z sum kontrolnych do sprawdzania integralności komunikatu.

The method used to send general messages of a certain format. This method uses checksums to verify the integrity of the message.

Parameters:

userName -

Nazwa użytkownika systemu EDInet (wielkość znaków nie ma znaczenia), na którego prawach będzie przetworzony komunikat

User Name EDInet system (case does not matter), whose rights will be processed the message

password -

Hasło użytkownika (istotna wielkość znaków)

User password (case-sensitive)

msgFmtId -

Identyfikator formatu komunikatu

message format ID

msgHandler -

Uchwyt danych komunikatu

Handler to the message data

params -

Tablica dodatkowych parametrów komunikatu, uwaga istotna kolejność!

An array of additional parameters of message, note the importance of order !

checksumAlg -

Algorytm, który został uzyty do wyznaczenia sumy kontrolnej komunikatu (CRC32, MD5, SHA1)

The algorithm that was used to determine the message checksum (CRC32, MD5, SHA1)

checksum -

Znakowa reprezentacja sumy kontrolnej komunikatu, CRC32 łancuch zawierający liczbę całkowita, MD5 i SHA1 łańcuch zawierający szestnastowy zapis dużej liczby całkowitej

Char data type of check sum of the message, CRC32 chain which contains integer number, MD5 and SHA1 chain which contains hexadecimal notation of a large integer.

system -

Nazwa systemu do którego loguje sie uzytkownik; dozwolone wartości: "EPRODUCENT" (domyślnie), "EHURTOWNIA"

System name in which user log in; allowed values: "EPRODUCENT" (default), "EHURTOWNIA"

Returns:

@see PutMessageResponse

putMessageSystemWithParams

@Deprecated
public static PutMessageResponse putMessageSystemWithParams(java.lang.String userName,
                                                                        java.lang.String password,
                                                                        java.lang.String msgFmtId,
                                                                        javax.activation.DataHandler msgHandler,
                                                                        java.lang.String[] params,
                                                                        java.lang.String system)

Deprecated.

Metoda służy do wysyłania ogólnych komunikatów o określonym formacie. Ta metoda korzysta z sum kontrolnych do sprawdzania integralności komunikatu.

The method used to send general messages of a certain format. This method uses checksums to verify the integrity of the message.

Parameters:

userName -

Nazwa użytkownika systemu EDInet (wielkość znaków nie ma znaczenia), na którego prawach będzie przetworzony komunikat

User Name EDInet system (case does not matter), whose rights will be processed the message

password -

Hasło użytkownika (istotna wielkość znaków)

User password (case-sensitive)

msgFmtId -

Identyfikator formatu komunikatu

message format ID

msgHandler -

Uchwyt danych komunikatu

Handler to the message data

params -

Tablica parametrów koniecznych do wstawienia komunikatu

Array of params

system -

Nazwa systemu do którego loguje sie uzytkownik; dozwolone wartości: "EPRODUCENT" (domyślnie), "EHURTOWNIA"

System name in which user log in; allowed values: "EPRODUCENT" (default), "EHURTOWNIA"

Returns:

@see PutMessageResponse

putMessageSystem

public static PutMessageResponse putMessageSystem(java.lang.String userName,
                                                  java.lang.String password,
                                                  java.lang.String msgFmtId,
                                                  javax.activation.DataHandler msgHandler,
                                                  java.lang.String system)

Metoda służy do wysyłania ogólnych komunikatów o określonym formacie.

The method used to send general messages of a certain format.

Parameters:

userName -

Nazwa użytkownika systemu EDInet (wielkość znaków nie ma znaczenia), na którego prawach będzie przetworzony komunikat

User Name EDInet system (case does not matter), whose rights will be processed the message

password -

Hasło użytkownika (istotna wielkość znaków)

User password (case-sensitive)

msgFmtId -

Identyfikator formatu komunikatu

message format ID

msgHandler -

Uchwyt danych komunikatu

Handler to the message data

system -

Nazwa systemu do którego loguje sie uzytkownik; dozwolone wartości: "EPRODUCENT" (domyślnie), "EHURTOWNIA"

System name in which user log in; allowed values: "EPRODUCENT" (default), "EHURTOWNIA"

Returns:

@see PutMessageResponse

putSignedMessageSystem

public static PutMessageResponse putSignedMessageSystem(java.lang.String userName,
                                                        java.lang.String password,
                                                        java.lang.String msgFmtId,
                                                        javax.activation.DataHandler msgHandler,
                                                        java.lang.String[] params,
                                                        java.lang.String signature,
                                                        java.lang.String cert,
                                                        java.lang.String system)

Metoda służy do wysyłania ogólnych komunikatów o określonym formacie. Korzysta z podpisu elektronicznego do sprawdzania integralności komunikatu.

The method used to send general messages of a certain format. It uses a digital signature to verify the integrity of the message.

Parameters:

userName -

Nazwa użytkownika systemu EDInet (wielkość znaków nie ma znaczenia), na którego prawach będzie przetworzony komunikat

User Name EDInet system (case does not matter), whose rights will be processed the message

password -

Hasło użytkownika (istotna wielkość znaków)

User password (case-sensitive)

msgFmtId -

Identyfikator formatu komunikatu

message format ID

msgHandler -

Uchwyt danych komunikatu

Handler to the message data

params -

Tablica parametrów koniecznych do wstawienia komunikatu

Array of params

signature -

Zakodowana w base64 znakowa reprezentacja podpisu elektronicznego dokumentu (obsługiwany algorytm to SHA1withRSA)

Zakodowana w base64 znakowa reprezentacja podpisu elektronicznego dokumentu (obsługiwany algorytm to SHA1withRSA)

cert -

Certyfikat nadawcy dokumentu w formacie PEM (gdy pole jest puste certyfikat pobierany jest z ustawien konta - sytuacja niezalecana), certyfikat z łańcucha służy do weryfikacji podpisu (rozszyfrowania łańcucha podpisu), certyfiakt z łańcucha musi być certyfikatem zaufanym w docelowym systemie.

Sender certificate in PEM format, certificate is used to verify the electronic signature, certificate must by trust in target system

system -

Nazwa systemu do którego loguje sie uzytkownik; dozwolone wartości: "EPRODUCENT" (domyślnie), "EHURTOWNIA"

System name in which user log in; allowed values: "EPRODUCENT" (default), "EHURTOWNIA"

Returns:

@see PutMessageResponse

putSignedMessageWithParams

public static PutMessageResponse putSignedMessageWithParams(java.lang.String userName,
                                                            java.lang.String password,
                                                            java.lang.String msgFmtId,
                                                            javax.activation.DataHandler msgHandler,
                                                            java.lang.String[] params,
                                                            java.lang.String signature,
                                                            java.lang.String cert)

Metoda służy do wysyłania ogólnych komunikatów o określonym formacie. Korzysta z podpisu elektronicznego do sprawdzania integralności komunikatu.

The method used to send general messages of a certain format. It uses a digital signature to verify the integrity of the message.

Parameters:

userName -

Nazwa użytkownika systemu EDInet (wielkość znaków nie ma znaczenia), na którego prawach będzie przetworzony komunikat

User Name EDInet system (case does not matter), whose rights will be processed the message

password -

Hasło użytkownika (istotna wielkość znaków)

User password (case-sensitive)

msgFmtId -

Identyfikator formatu komunikatu

message format ID

msgHandler -

Uchwyt danych komunikatu

Handler to the message data

params -

Tablica parametrów koniecznych do wstawienia komunikatu

Array of params

signature -

Zakodowana w base64 znakowa reprezentacja podpisu elektronicznego dokumentu (obsługiwany algorytm to SHA1withRSA)

Char data type of electronic signature of the message encoded in base64 (supported by algorithm SHA1withRSA)

cert -

Certyfikat nadawcy dokumentu w formacie PEM (gdy pole jest puste certyfikat pobierany jest z ustawien konta - sytuacja niezalecana), certyfikat z łańcucha służy do weryfikacji podpisu (rozszyfrowania łańcucha podpisu), certyfiakt z łańcucha musi być certyfikatem zaufanym w docelowym systemie.

Sender certificate in PEM format, certificate is used to verify the electronic signature, certificate must by trust in target system

Returns:

@see PutMessageResponse

putSignedMessage

public static PutMessageResponse putSignedMessage(java.lang.String userName,
                                                  java.lang.String password,
                                                  java.lang.String msgFmtId,
                                                  byte[] msgBytes,
                                                  java.lang.String msgContentType,
                                                  java.lang.String signature,
                                                  java.lang.String cert)

Metoda służy do wysyłania podpisanych komunikatów o określonym formacie. Wiadomośc zawarta w tablicy bajtów. Korzysta z podpisu elektronicznego do sprawdzania integralności komunikatu.

The method used to send general messages of a certain format. Message passed in byte array. It uses a digital signature to verify the integrity of the message.

Parameters:

userName -

Nazwa użytkownika systemu EDInet (wielkość znaków nie ma znaczenia), na którego prawach będzie przetworzony komunikat

User Name EDInet system (case does not matter), whose rights will be processed the message

password -

Hasło użytkownika (istotna wielkość znaków)

User password (case-sensitive)

msgFmtId -

Identyfikator formatu komunikatu

message format ID

msgBytes -

Binarna postac tresci komunikatu

message in byte array

msgContentType -

Typ zawartosci komunikatu, np. text/plain lub text/xml

Message content type e.g. (text/plain, text/xml)

signature -

Zakodowana w base64 znakowa reprezentacja podpisu elektronicznego dokumentu (obsługiwany algorytm to SHA1withRSA<)/div>

Char data type of electronic signature of the message encoded in base64 (supported by algorithm SHA1withRSA)

cert -

Certyfikat nadawcy dokumentu w formacie PEM (gdy pole jest puste certyfikat pobierany jest z ustawien konta - sytuacja niezalecana), certyfikat z łańcucha służy do weryfikacji podpisu (rozszyfrowania łańcucha podpisu), certyfiakt z łańcucha musi być certyfikatem zaufanym w docelowym systemie.

Sender certificate in PEM format, certificate is used to verify the electronic signature, certificate must by trust in target system

Returns:

PutMessageResponse jako XML

setMessageLocationSystem

public static PutMessageResponse setMessageLocationSystem(java.lang.String userName,
                                                          java.lang.String password,
                                                          java.lang.String msgId,
                                                          int locationCode,
                                                          java.lang.String system)

Usługa umożliwia ustawianie statusu (lokalizacji) dokumentów pobranych z systemu EDInet na prawach podanego użytkownika. W szczególności służy do potwierdzenia otrzymania dokumentu. Lista kodów do ustalenia, na razie dostępne są :

• 51 (ZADANIA RECEIPT)- Potwierdzono otrzymanie dokumentu
• 52 (ZADANIA DELIVERED)- Dostarczono dokument (do docelowego adresata)
• 53 (ZADANIA NONDELIVER)- Niedostarczono dokumentu (do docelowego adresata)

The service allows to set the status (location) of documents received from the EDInet system on the user rights. In particular, use to confirm the receipt. List of codes to set up, available now:

• 51 (RECEIPT)
• 52 (DELIVERED)
• 53 (NONDELIVER)

W odpowiedzi na wysłany komunikat zwracane są podstawowe informacje diagnostyczne opisane przez klasę PutMessageResponse: kod błędu i ew. informacja o błędzie oraz identyfikator dokumentu (kontrolnie).

In response on a sent message, the basic diagnostic information are returned described by class PutMessageResponse : the error code and error message and ID document (control).

Parameters:

userName -

Nazwa użytkownika systemu EDInet (wielkość znaków nie ma znaczenia), na którego prawach będzie przetworzony komunikat

User Name EDInet system (case does not matter), whose rights will be processed the message

password -

Hasło użytkownika (istotna wielkość znaków)

User password (case-sensitive)

msgFmtId -

Identyfikator formatu komunikatu

message format ID

locationCode -

lokalizacja

Location code

system -

System/div>

System

Returns:

@see PutMessageResponse

setMessageLocation

public static PutMessageResponse setMessageLocation(java.lang.String userName,
                                                    java.lang.String password,
                                                    java.lang.String msgId,
                                                    int locationCode)

Przeciazenie metody SetMessageLocation, bez koniecznosci podawania systemu

SetMessageLocation method is overloaded, no necessity to enter the system.

setMessageLocationWithReceiverDesc

public static PutMessageResponse setMessageLocationWithReceiverDesc(java.lang.String userName,
                                                                    java.lang.String password,
                                                                    java.lang.String msgId,
                                                                    int locationCode,
                                                                    java.lang.String receiverCode,
                                                                    java.lang.String receiverDescription)

Przeciazenie metody SetMessageLocation, bez koniecznosci podawania systemu, z możliwością przesłania własnego kodu operacji i jej opisu.

class="en">SetMessageLocation method is overloaded, no necessity to enter the system but with the possibility of sending own operation code and its description.

setSentMessageLocationWithReceiverDesc

public static PutMessageResponse setSentMessageLocationWithReceiverDesc(java.lang.String userName,
                                                                        java.lang.String password,
                                                                        java.lang.String msgId,
                                                                        int locationCode,
                                                                        java.lang.String receiverDescription)

Usługa umożliwia ustawianie statusu (lokalizacji) dokumentów wysłanych do systemu EDInet na prawach podanego użytkownika. W szczególności służy do anulowania wysłanego dokumentu. Lista kodów do ustalenia, m. in. dostępne są :

• 11 (DOCUMENT ERROR)
• 13 (DOCUMENT ACCEPTED)
• 14 (DOCUMENT REJECTED)
• 15 (DOCUMENT CANCELED)
• 16 (DOCUMENT UNCANCELED)

The service allows to set the status (location) of documents sent to the EDInet system on the user rights. In particular, use to cancel the document. List of codes to set up, including:

• 11 (DOCUMENT ERROR)
• 13 (DOCUMENT ACCEPTED)
• 14 (DOCUMENT REJECTED)
• 15 (DOCUMENT CANCELED)
• 16 (DOCUMENT UNCANCELED)

W odpowiedzi na wysłany komunikat zwracane są podstawowe informacje diagnostyczne opisane przez klasę PutMessageResponse: kod błędu i ew. informacja o błędzie oraz identyfikator dokumentu (kontrolnie).

In response on a sent message, the basic diagnostic information are returned described by class PutMessageResponse : the error code and error message and ID document (control).

Parameters:

userName -

Nazwa użytkownika systemu EDInet (wielkość znaków nie ma znaczenia), na którego prawach będzie przetworzony komunikat

User Name EDInet system (case does not matter), whose rights will be processed the message

password -

Hasło użytkownika (istotna wielkość znaków)

User password (case-sensitive)

msgId -

guid identyfikujący dokument

Guid

locationCode -

kod liczbowy lokalizacji

Location code

receiverDescription -

dodatkowy opis uzytkownika

Receiver description