pl.infinite.edinetws

Class MessageInputSimple

java.lang.Object

pl.infinite.edinetws.MessageInputSimple

public class MessageInputSimple
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 XML odzwierciedlajacy klasę PutMessageResponse:

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.

   <PutMessageResponse>
     <StatusCode></StatusCode>
     <StatusInfo></StatusInfo>
     <MessageId></MessageId>
   </PutMessageResponse>
 

See Also:

MessageInput, PutMessageResponse

Constructor Summary

Constructors

Constructor and Description
MessageInputSimple()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	putMessage(java.lang.String userName, java.lang.String password, java.lang.String msgFmtId, byte[] msgBytes, java.lang.String msgContentType) Przeciazenie metody głównej, bez konieczności podawania ciągu parametrów i sum kontrolnych. The main method is overloaded, no necessity to enter the parameters and checksums.
static java.lang.String	putMessageSystem(java.lang.String userName, java.lang.String password, java.lang.String msgFmtId, byte[] msgBytes, java.lang.String msgContentType, java.lang.String system) Przeciazenie metody głównej, bez konieczności podawania ciągu parametrów i sum kontrolnych. The main method is overloaded, no necessity to enter the parameters and checksums.
static java.lang.String	putMessageSystemWithControl(java.lang.String userName, java.lang.String password, java.lang.String msgFmtId, byte[] msgBytes, java.lang.String msgContentType, 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 java.lang.String	putMessageSystemWithParams(java.lang.String userName, java.lang.String password, java.lang.String msgFmtId, byte[] msgBytes, java.lang.String msgContentType, java.lang.String[] params, java.lang.String system) Deprecated.
static java.lang.String	putMessageWithControl(java.lang.String userName, java.lang.String password, java.lang.String msgFmtId, byte[] msgBytes, java.lang.String msgContentType, 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 java.lang.String	putMessageWithParams(java.lang.String userName, java.lang.String password, java.lang.String msgFmtId, byte[] msgBytes, java.lang.String msgContentType, java.lang.String params) Deprecated.
static java.lang.String	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 java.lang.String	setMessageLocation(java.lang.String userName, java.lang.String password, java.lang.String msgId, int locationCode) Usługa umożliwia ustawianie statusu (lokalizacji) dokumentów pobranych z systemu EDInet na prawach podanego użytkownika.
static java.lang.String	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 z możliwością przesłania własnego kodu operacji i jej opisu. SetMessageLocation Method is overloaded with the possibility of sending its operation code and its description.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageInputSimple

public MessageInputSimple()

Method Detail

putMessageWithControl

public static java.lang.String putMessageWithControl(java.lang.String userName,
                                                     java.lang.String password,
                                                     java.lang.String msgFmtId,
                                                     byte[] msgBytes,
                                                     java.lang.String msgContentType,
                                                     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

msgBytes -

Binarna postac tresci komunikatu

Binarna postac tresci komunikatu

msgContentType -

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

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

params -

Ciag parametrow porozdzielanych znakiem |, uwaga istotna kolejność!

Parameters divided by | sign. The sequence is important.

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 zawierajaćy 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 alarge integer.

Returns:

PutMessageResponse jako XML

putMessageWithParams

@Deprecated
public static java.lang.String putMessageWithParams(java.lang.String userName,
                                                                java.lang.String password,
                                                                java.lang.String msgFmtId,
                                                                byte[] msgBytes,
                                                                java.lang.String msgContentType,
                                                                java.lang.String params)

Deprecated.

Przeciazenie metody głównej, bez konieczności podawania sum kontrolnych.

The main method is overloaded, no necessity to enter and checksums.

putMessage

public static java.lang.String putMessage(java.lang.String userName,
                                          java.lang.String password,
                                          java.lang.String msgFmtId,
                                          byte[] msgBytes,
                                          java.lang.String msgContentType)

Przeciazenie metody głównej, bez konieczności podawania ciągu parametrów i sum kontrolnych.

The main method is overloaded, no necessity to enter the parameters and checksums.

putMessageSystemWithControl

public static java.lang.String putMessageSystemWithControl(java.lang.String userName,
                                                           java.lang.String password,
                                                           java.lang.String msgFmtId,
                                                           byte[] msgBytes,
                                                           java.lang.String msgContentType,
                                                           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

msgBytes -

Binarna postac tresci komunikatu

Binarna postac tresci komunikatu

msgContentType -

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

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

params -

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

Array of parameters. The sequence is important.

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 zawierajaćy 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 alarge integer.

system -

String 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 java.lang.String putMessageSystemWithParams(java.lang.String userName,
                                                                      java.lang.String password,
                                                                      java.lang.String msgFmtId,
                                                                      byte[] msgBytes,
                                                                      java.lang.String msgContentType,
                                                                      java.lang.String[] params,
                                                                      java.lang.String system)

Deprecated.

Przeciazenie metody głównej, bez konieczności podawania sum kontrolnych.

The main method is overloaded, no necessity to enter and checksums.

putMessageSystem

public static java.lang.String putMessageSystem(java.lang.String userName,
                                                java.lang.String password,
                                                java.lang.String msgFmtId,
                                                byte[] msgBytes,
                                                java.lang.String msgContentType,
                                                java.lang.String system)

Przeciazenie metody głównej, bez konieczności podawania ciągu parametrów i sum kontrolnych.

The main method is overloaded, no necessity to enter the parameters and checksums.

putSignedMessage

public static java.lang.String 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. Korzysta z podpisu elektronicznego do sprawdzania integralności komunikatu.

The method used to send general messages of a certain format. It uses an electronic 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

Binary form of the message contents

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)

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

setMessageLocation

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

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)

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).

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)

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

Returns:

PutMessageResponse jako XML

setMessageLocationWithReceiverDesc

public static java.lang.String 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 z możliwością przesłania własnego kodu operacji i jej opisu.

SetMessageLocation Method is overloaded with the possibility of sending its operation code and its description.