de.knightsoftnet.validators.server.rest.api

Class PhoneNumberService

java.lang.Object

de.knightsoftnet.validators.server.rest.api.PhoneNumberService

@Path(value="phonenumberservice")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public class PhoneNumberService
extends Object

phone number web service brings phone number util functions to client.

Author:

Manfred Tremmel

Constructor Summary

Constructors

Constructor and Description
PhoneNumberService()

Method Summary

Modifier and Type	Method and Description
String	formatCommon(String planguage, String pcountry, String pphoneNumber)
String	formatCommonInternational(String planguage, String pcountry, String pphoneNumber)
de.knightsoftnet.validators.shared.data.ValueWithPos<String>	formatCommonInternationalWithPos(ValueWithPosAndCountry<String> pphoneNumber)
String	formatCommonNational(String planguage, String pcountry, String pphoneNumber)
de.knightsoftnet.validators.shared.data.ValueWithPos<String>	formatCommonNationalWithPos(ValueWithPosAndCountry<String> pphoneNumber)
de.knightsoftnet.validators.shared.data.ValueWithPos<String>	formatCommonWithPos(ValueWithPosAndCountry<String> pphoneNumber)
String	formatDin5008(String planguage, String pcountry, String pphoneNumber)
String	formatDin5008International(String planguage, String pcountry, String pphoneNumber)
de.knightsoftnet.validators.shared.data.ValueWithPos<String>	formatDin5008InternationalWithPos(ValueWithPosAndCountry<String> pphoneNumber)
String	formatDin5008National(String planguage, String pcountry, String pphoneNumber)
de.knightsoftnet.validators.shared.data.ValueWithPos<String>	formatDin5008NationalWithPos(ValueWithPosAndCountry<String> pphoneNumber)
de.knightsoftnet.validators.shared.data.ValueWithPos<String>	formatDin5008WithPos(ValueWithPosAndCountry<String> pphoneNumber)
String	formatE123(String planguage, String pcountry, String pphoneNumber)
String	formatE123International(String planguage, String pcountry, String pphoneNumber)
de.knightsoftnet.validators.shared.data.ValueWithPos<String>	formatE123InternationalWithPos(ValueWithPosAndCountry<String> pphoneNumber)
String	formatE123National(String planguage, String pcountry, String pphoneNumber)
de.knightsoftnet.validators.shared.data.ValueWithPos<String>	formatE123NationalWithPos(ValueWithPosAndCountry<String> pphoneNumber)
de.knightsoftnet.validators.shared.data.ValueWithPos<String>	formatE123WithPos(ValueWithPosAndCountry<String> pphoneNumber)
String	formatMs(String planguage, String pcountry, String pphoneNumber)
de.knightsoftnet.validators.shared.data.ValueWithPos<String>	formatMsWithPos(ValueWithPosAndCountry<String> pphoneNumber)
String	formatRfc3966(String planguage, String pcountry, String pphoneNumber)
de.knightsoftnet.validators.shared.data.ValueWithPos<String>	formatRfc3966WithPos(ValueWithPosAndCountry<String> pphoneNumber)
String	formatUrl(String planguage, String pcountry, String pphoneNumber)
de.knightsoftnet.validators.shared.data.ValueWithPos<String>	formatUrlWithPos(ValueWithPosAndCountry<String> pphoneNumber)
List<de.knightsoftnet.validators.shared.data.PhoneNumberData>	getSuggestions(String planguage, String psearch, int plimit)
PhoneNumberDataWithFormats	parseAndFormatPhoneNumber(String planguage, String pcountry, String pphoneNumber) parse and reformat the phone number in all available formats.
de.knightsoftnet.validators.shared.data.PhoneNumberData	parsePhoneNumber(String planguage, String pcountry, String pphoneNumber)
de.knightsoftnet.validators.shared.data.ValueWithPos<de.knightsoftnet.validators.shared.data.PhoneNumberData>	parsePhoneNumber(ValueWithPosAndCountry<String> pphoneNumber)
Boolean	validate(String pcountry, String pphoneNumber, Boolean pdin5008, Boolean pe123, Boolean puri, Boolean pms, Boolean pcommon) validate a phone number.

Methods inherited from class java.lang.Object

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

Constructor Detail

PhoneNumberService

public PhoneNumberService()

Method Detail

parsePhoneNumber

@GET
 @Path(value="parsePhoneNumber")
public de.knightsoftnet.validators.shared.data.PhoneNumberData parsePhoneNumber(@QueryParam(value="language")
                                                                                                                      String planguage,
                                                                                                                      @QueryParam(value="country")
                                                                                                                      String pcountry,
                                                                                                                      @QueryParam(value="phonenumber")
                                                                                                                      String pphoneNumber)

parsePhoneNumber

@PUT
 @Path(value="parsewithpos")
public de.knightsoftnet.validators.shared.data.ValueWithPos<de.knightsoftnet.validators.shared.data.PhoneNumberData> parsePhoneNumber(ValueWithPosAndCountry<String> pphoneNumber)

parseAndFormatPhoneNumber

@GET
 @Path(value="parseandformat")
public PhoneNumberDataWithFormats parseAndFormatPhoneNumber(@QueryParam(value="language")
                                                                                                String planguage,
                                                                                                @QueryParam(value="country")
                                                                                                String pcountry,
                                                                                                @QueryParam(value="phonenumber")
                                                                                                String pphoneNumber)

parse and reformat the phone number in all available formats.

Parameters:

planguage - language to use

pcountry - default country

pphoneNumber - phone number to format

Returns:

PhoneNumberDataWithFormats

formatE123

@GET
 @Path(value="formate123")
public String formatE123(@QueryParam(value="language")
                                                         String planguage,
                                                         @QueryParam(value="country")
                                                         String pcountry,
                                                         @QueryParam(value="phonenumber")
                                                         String pphoneNumber)

formatE123WithPos

@PUT
 @Path(value="formate123withpos")
public de.knightsoftnet.validators.shared.data.ValueWithPos<String> formatE123WithPos(ValueWithPosAndCountry<String> pphoneNumber)

formatE123International

@GET
 @Path(value="formate123international")
public String formatE123International(@QueryParam(value="language")
                                                                                   String planguage,
                                                                                   @QueryParam(value="country")
                                                                                   String pcountry,
                                                                                   @QueryParam(value="phonenumber")
                                                                                   String pphoneNumber)

formatE123InternationalWithPos

@PUT
 @Path(value="formate123internationalwithpos")
public de.knightsoftnet.validators.shared.data.ValueWithPos<String> formatE123InternationalWithPos(ValueWithPosAndCountry<String> pphoneNumber)

formatE123National

@GET
 @Path(value="formate123national")
public String formatE123National(@QueryParam(value="language")
                                                                         String planguage,
                                                                         @QueryParam(value="country")
                                                                         String pcountry,
                                                                         @QueryParam(value="phonenumber")
                                                                         String pphoneNumber)

formatE123NationalWithPos

@PUT
 @Path(value="formate123nationalwithpos")
public de.knightsoftnet.validators.shared.data.ValueWithPos<String> formatE123NationalWithPos(ValueWithPosAndCountry<String> pphoneNumber)

formatDin5008

@GET
 @Path(value="formatdin5008")
public String formatDin5008(@QueryParam(value="language")
                                                               String planguage,
                                                               @QueryParam(value="country")
                                                               String pcountry,
                                                               @QueryParam(value="phonenumber")
                                                               String pphoneNumber)

formatDin5008WithPos

@PUT
 @Path(value="formatdin5008withpos")
public de.knightsoftnet.validators.shared.data.ValueWithPos<String> formatDin5008WithPos(ValueWithPosAndCountry<String> pphoneNumber)

formatDin5008International

@GET
 @Path(value="formatdin5008international")
public String formatDin5008International(@QueryParam(value="language")
                                                                                         String planguage,
                                                                                         @QueryParam(value="country")
                                                                                         String pcountry,
                                                                                         @QueryParam(value="phonenumber")
                                                                                         String pphoneNumber)

formatDin5008InternationalWithPos

@PUT
 @Path(value="formatdin5008internationalwithpos")
public de.knightsoftnet.validators.shared.data.ValueWithPos<String> formatDin5008InternationalWithPos(ValueWithPosAndCountry<String> pphoneNumber)

formatDin5008National

@GET
 @Path(value="formatdin5008national")
public String formatDin5008National(@QueryParam(value="language")
                                                                               String planguage,
                                                                               @QueryParam(value="country")
                                                                               String pcountry,
                                                                               @QueryParam(value="phonenumber")
                                                                               String pphoneNumber)

formatDin5008NationalWithPos

@PUT
 @Path(value="formatdin5008nationalwithpos")
public de.knightsoftnet.validators.shared.data.ValueWithPos<String> formatDin5008NationalWithPos(ValueWithPosAndCountry<String> pphoneNumber)

formatRfc3966

@GET
 @Path(value="formatrfc3966")
public String formatRfc3966(@QueryParam(value="language")
                                                               String planguage,
                                                               @QueryParam(value="country")
                                                               String pcountry,
                                                               @QueryParam(value="phonenumber")
                                                               String pphoneNumber)

formatRfc3966WithPos

@PUT
 @Path(value="formatrfc3966withpos")
public de.knightsoftnet.validators.shared.data.ValueWithPos<String> formatRfc3966WithPos(ValueWithPosAndCountry<String> pphoneNumber)

formatMs

@GET
 @Path(value="formatms")
public String formatMs(@QueryParam(value="language")
                                                     String planguage,
                                                     @QueryParam(value="country")
                                                     String pcountry,
                                                     @QueryParam(value="phonenumber")
                                                     String pphoneNumber)

formatMsWithPos

@PUT
 @Path(value="formatmswithpos")
public de.knightsoftnet.validators.shared.data.ValueWithPos<String> formatMsWithPos(ValueWithPosAndCountry<String> pphoneNumber)

formatUrl

@GET
 @Path(value="formaturl")
public String formatUrl(@QueryParam(value="language")
                                                       String planguage,
                                                       @QueryParam(value="country")
                                                       String pcountry,
                                                       @QueryParam(value="phonenumber")
                                                       String pphoneNumber)

formatUrlWithPos

@PUT
 @Path(value="formaturlwithpos")
public de.knightsoftnet.validators.shared.data.ValueWithPos<String> formatUrlWithPos(ValueWithPosAndCountry<String> pphoneNumber)

formatCommon

@GET
 @Path(value="formatcommon")
public String formatCommon(@QueryParam(value="language")
                                                             String planguage,
                                                             @QueryParam(value="country")
                                                             String pcountry,
                                                             @QueryParam(value="phonenumber")
                                                             String pphoneNumber)

formatCommonWithPos

@PUT
 @Path(value="formatcommonwithpos")
public de.knightsoftnet.validators.shared.data.ValueWithPos<String> formatCommonWithPos(ValueWithPosAndCountry<String> pphoneNumber)

formatCommonInternational

@GET
 @Path(value="formatcommoninternational")
public String formatCommonInternational(@QueryParam(value="language")
                                                                                       String planguage,
                                                                                       @QueryParam(value="country")
                                                                                       String pcountry,
                                                                                       @QueryParam(value="phonenumber")
                                                                                       String pphoneNumber)

formatCommonInternationalWithPos

@PUT
 @Path(value="formatcommoninternationalwithpos")
public de.knightsoftnet.validators.shared.data.ValueWithPos<String> formatCommonInternationalWithPos(ValueWithPosAndCountry<String> pphoneNumber)

formatCommonNational

@GET
 @Path(value="formatcommonnational")
public String formatCommonNational(@QueryParam(value="language")
                                                                             String planguage,
                                                                             @QueryParam(value="country")
                                                                             String pcountry,
                                                                             @QueryParam(value="phonenumber")
                                                                             String pphoneNumber)

formatCommonNationalWithPos

@PUT
 @Path(value="formatcommonnationalwithpos")
public de.knightsoftnet.validators.shared.data.ValueWithPos<String> formatCommonNationalWithPos(ValueWithPosAndCountry<String> pphoneNumber)

getSuggestions

@GET
 @Path(value="getsuggestions")
public List<de.knightsoftnet.validators.shared.data.PhoneNumberData> getSuggestions(@QueryParam(value="language")
                                                                                                                        String planguage,
                                                                                                                        @QueryParam(value="search")
                                                                                                                        String psearch,
                                                                                                                        @QueryParam(value="limit")
                                                                                                                        int plimit)

validate

@GET
 @Path(value="validate")
public Boolean validate(@QueryParam(value="country")
                                                      String pcountry,
                                                      @QueryParam(value="phonenumber")
                                                      String pphoneNumber,
                                                      @QueryParam(value="din5008")
                                                      Boolean pdin5008,
                                                      @QueryParam(value="e123")
                                                      Boolean pe123,
                                                      @QueryParam(value="uri")
                                                      Boolean puri,
                                                      @QueryParam(value="ms")
                                                      Boolean pms,
                                                      @QueryParam(value="common")
                                                      Boolean pcommon)

validate a phone number.

Parameters:

pcountry - default country

pphoneNumber - phone number to check

pdin5008 - set to true if DIN 5008 format is allowed

pe123 - set to true if E123 format is allowed

puri - set to true if URI format is allowed

pms - set to true if Microsoft format is allowed

pcommon - set to true if common format is allowed

Returns:

true if number is valid