Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Atributos

 

lógico

lVerbose

          

Habilita log em arquivo para os comandos SOAP enviados e recebidos. Valor padrão: .F.

 

lógico

lStatus

          

Obtém status de sucesso (.T.) ou falha (.F.) da operação realizada. Atributo somente leitura. 

lógico

lEnableOptAttr

          

Habilita no comando SOAP de envio os atributos opcionais. Valor padrão: .F.

 

caractere

cCurrentOperation

          

Obtém o nome da operação atual. Atributo somente leitura.

 

numérico

nTimeout

          

Obtém o valor de timeout em segundos para envio e recebimento dos documentos SOAP. Valor padrão: 0 - sem timeout. 

lógico

lProcResp

          

Habilita processamento da mensagem de resposta do servidor WSDL. Valor padrão: .T. 

caractere

cError

          

Obtém a mensagem de erro para o último comando executado. Atributo somente leitura. 

caractere

cFaultCode

          

Obtém fault code da mensagem de retorno do servidor. Atributo somente leitura. 

caractere

cFaultSubCode

          

Obtém fault subcode da mensagem de retorno do servidor. Atributo somente leitura.

 

caractere

cFaultString

          

Obtém fault string da mensagem de retorno do servidor. Atributo somente leitura.

 

caractere

cFaultActor

          

Obtém fault actor da mensagem de retorno do servidor. Atributo somente leitura.

 

caractere

cLocation

          

Obtém o endreço do servidor que receberá a mensagem SOAP. 

caractere

cSSLCACertFile

          

Obtém o arquivo de certificado de CA usado para conexão SSL com o servidor que receberá a mensagem SOAP. O atributo aceita apenas caminho de arquivos do server caso contrário mostrará o erro "Invalid SSL CA Certificate File – Only Server Path allowed".

 

caractere

cSSLCertFile

          

Obtém o arquivo de certificado cliente usado para conexão SSL com o servidor que receberá a mensagem SOAP. O atributo aceita apenas caminho de arquivos do server caso contrário mostrará o erro "Invalid SSL Certificate File – Only Server Path allowed".

 

caractere

cSSLKeyFile

          

Obtém o arquivo de chave primária usado para conexão SSL com o servidor que receberá a mensagem SOAP. O atributo aceita apenas caminho de arquivos do server caso contrário mostrará o erro "Invalid SSL Key File – Only Server Path allowed". 

caractere

cSSLKeyPwd

          

Obtém a senha para o certificado usado para conexão SSL com o servidor que receberá a mensagem SOAP.

 

lógico

lUseNSPrefix

          

Define se vai usar prefixo de namespace antes dos nomes das tags na mensagem SOAP que será enviada. Valor padrão: .F.

 

lógico

lCheckInput

          

Define se vai verificar as ocorrências dos parâmetros de entrada da mensagem SOAP que será enviada, quando essa não for uma mensagem personalizada. Valor padrão: .T. 


Resumo dos Métodos

 

 

New()

          

Cria uma nova instância da classe TWsdlManager. 

lógico

ParseFile(caractere cFile)

          

Realiza o parse de um arquivo WSDL através do parâmetro recebido indicando o local do mesmo.

 

lógico

ParseURL(caractere cURL)

          

Realiza o parse de uma URL que aponta para um arquivo WSDL através do parâmetro recebido indicando o local do mesmo. 

vetor

ListOperations()

          

Lista as operações definidas no arquivo WSDL. 

lógico

SetOperation(caractere cOperation)

          

O método define a operação atual através do parâmetro cOperation. 

caractere

GetWsdlDoc()

          

Retorna a documentação do documento WSDL. 

vetor

SimpleInput()

          

Lista os tipos simples de input para a operação definida. 

vetor

ComplexInput()

          

Lista os tipos complexos de input para a operação definida que possuem número variável de ocorrências – minOccurs < maxOccurs --. 

vetor

SimpleOutput()

          

Lista os tipos simples de output para a operação definida. 

vetor

ComplexOutput()

          

Lista os tipos complexos de output para a operação definida.

 

vetor

SimpleFault()

          

Lista os tipos simples de fault para a operação definida.

 

vetor

ComplexFault()

          

Lista os tipos complexos de fault para a operação definida.

 

lógico

SetComplexOccurs(numérico nId, numérico nValue)

          

O método define o número de vezes que um elemento do tipo complexo vai aparecer. 

lógico

SetValue(numérico nId, caractere cValue)

          

O método define o valor de entrada para um elemento do WSDL. 

lógico

SetValues(numérico nId, vetor aValues)

          

O método define um vetor de valores de entrada para um elemento do WSDL. 

lógico

SetFirst(caractere cName, caractere cValue)

          

O método define o valor de entrada para a primeira ocorrência de um elemento do WSDL. 

lógico

SetFirstArray(caractere cName, vetor aValues)

          

O método define um vetor de valores de entrada para a primeira ocorrência um elemento do WSDL.

 

lógico

SetValPar(caractere cName, vetor aParents, caractere cValue)

          

O método define o valor de entrada para um elemento do WSDL, dado os elementos pais.

 

lógico

SetValParArray(caractere cName, vetor aParents, vetor aValues)

          

O método define um vetor de valores de entrada para um elemento do WSDL, dado os elementos pais. 

lógico

AddHttpHeader(caractere cName, caractere cValue)

          

O método adiciona um cabeçalho HTTP à lista de cabeçalhos que serão enviados na mensagem SOAP destinada ao servidor do WSDL. 

caractere

GetSoapMsg()

          

Retorna o documento SOAP que será enviado ao servidor.

 

lógico

SendSoapMsg(caractere cMsg)

          

Envio o documento SOAP gerado ao endereço definido. 

caractere

GetSoapResponse()

          

Retorna o documento SOAP de resposta rcebido do servidor.

 

caractere

GetParsedResponse()

          

Retorna uma string contendo a mensagem SOAP de resposta parseada.

 

 

SetProxy(caractere cHost, numérico nPort)

          

Define o host e porta do proxy para fazer a conexão HTTP.

 

lógico

GetProxy(caractere @cHost, numérico @nPort)

          

Retorna o host e porta do proxy para fazer a conexão HTTP. 

 

SetCredentials(caractere cUser, caractere cPass)

          

Define o usuário e senha do proxy para fazer a conexão HTTP.

 

lógico

GetCredentials(caractere @cUser, caractere @cPass)

          

Retorna o usuário e senha do proxy para fazer a conexão HTTP.

 

 

SetAuthentication(caractere cUser, caractere cPass)

          

Define o usuário e senha usados para fazer autenticação HTTP. 

lógico

GetAuthentication(caractere @cUser, caractere @cPass)

          

Retorna o usuário e senha usados para fazer autenticação HTTP. 


Detalhes dos Métodos

Âncora
new()
new()
New
New()
Cria uma nova instância da classe TWsdlManager.

...

Parâmetros:
caractere cName (obrigatório) - Nome do elemento igual ao informado pela função SimpleInput.
caractere cValue (obrigatório) - Valor para esse elemento.
Retorno:
lógico lRet - Verdadeiro (.T.) caso consiga definir. Falso (.F.) caso contrário.
Exemplos:
   User Function Teste()     Local oWsdl     Local xRet          // Cria o objeto da classe TWsdlManager     oWsdl := TWsdlManager():New()          // Faz o parse de uma URL     xRet := oWsdl:ParseURL( "http://wsf.cdyne.com/WeatherWS/Weather.asmx?WSDL" )     if xRet == .F.        conout( "Erro: "  oWsdl:cError )        Return     endif          // Define a operação     xRet := oWsdl:SetOperation( "GetCityForecastByZIP" )     if xRet == .F.       conout( "Erro: "  oWsdl:cError )       Return     endif          // Define o valor de cada parâmeto necessário     xRet := oWsdl:SetFirst( "ZIP", "90210" )     if xRet == .F.        conout( "Erro: " + oWsdl:cError )        Return      endif   Return        Return     endif   Return

...

Âncora
setfirstarray()
setfirstarray()
SetFirstArray
lógico SetFirstArray(caractere cName, vetor aValues)
O método define um vetor de valores de entrada para a primeira ocorrência um elemento do WSDL.

...

Âncora
getsoapresponse()
getsoapresponse()
GetSoapResponse
caractere GetSoapResponse()
Retorna o documento SOAP de resposta rcebido do servidor.
Retorno:
caractere cRet - Retorna o documento SOAP de resposta rcebido do servidor.
Exemplos:
   User Function Teste()     Local oWsdl     Local xRet          // Cria o objeto da classe TWsdlManager     oWsdl := TWsdlManager():New()          // Faz o parse de uma URL     xRet := oWsdl:ParseURL( "http://wsf.cdyne.com/WeatherWS/Weather.asmx?WSDL" )     if xRet == .F.       conout( "Erro: "  oWsdl:cError )       Return     endif          // Define a operação     xRet := oWsdl:SetOperation( "GetCityForecastByZIP" )     if xRet == .F.       conout( "Erro: "  oWsdl:cError )       Return      endif                 Return     endif          // Define o valor de cada parâmeto necessário     xRet := oWsdl:SetValue( 0, "90210" )     if xRet == .F.       conout( "Erro: "  oWsdl:cError )       Return     endif          // Envia a mensagem SOAP ao servidor     xRet := oWsdl:SendSoapMsg()     if xRet == .F.       conout( "Erro: "  oWsdl:cError )       Return     endif          // Pega a mensagem de resposta     conout( oWsdl:GetSoapResponse() )   Return

...